Conversation

The Conversation endpoints allows you to retrieve about channels used with Conversation API.

Get Instagram channel information Closed Beta 

  Returns the information for an Instagram channel linked to a Conversation API App.
SecurityBasic or OAuth2.0
Request
path Parameters
projectId
required
string

The unique ID of the project. You can find this on the Sinch Dashboard.

conversationAppId
required
string

The unique ID of the app. You can find this on the Sinch Dashboard.

Responses
200

Instagram information.

Response Schema: application/json
status
required
string

Channel integration status.

Enum: "ACTIVE" "ERROR" "FAILING" "PENDING" "UNRECOGNIZED"
statusDescription
string

Channel integration description if status is ERROR or FAILED.

id
string

Instagram ID.

name
string

Public profile name if set.

username
string

Profile username.

biography
string

Public profile biography if set.

followersCount
number

Total number of Instagram users following the sender.

followsCount
number

Total number of Instagram users the sender follows.

mediaCount
number

Total number of Instagram Media published on the sender.

profilePictureUrl
string

Public profile picture URL if set.

website
string

Public profile website URL if set.

400

BadRequest

401

Unauthorized

404

NotFound

500

InternalServerError

get/v1/projects/{projectId}/conversation/apps/{conversationAppId}/instagram
Request samples 
Response samples 
application/json
The information for the Instagram page connected to the Conversation API App.



{
  • "id": "1234567890",
  • "username": "Sinch",
  • "status": "ACTIVE",
  • "followersCount": 1,
  • "followsCount": 3,
  • "mediaCount": 0
}
Get Facebook Messenger channel information Closed Beta 
Returns the information for a Facebook Messenger channel linked to a Conversation API App.



SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
conversationAppId
required
string
The unique ID of the app. You can find this on the Sinch Dashboard.


 
Responses 
200
Facebook Messenger information.


Response Schema: application/json
status
required
string
Channel integration status.


 Enum: "ACTIVE" "ERROR" "FAILING" "PENDING" "UNRECOGNIZED"  
statusDescription
string
Channel integration description if status is ERROR or FAILED.


 
id
string
The ID of the page.


 
name
string
The name of the page.


 
globalBrandPageName
string
The name of the Page with country codes appended for Global Pages. Only visible to the Page admin.


 
400
BadRequest


401
Unauthorized


404
NotFound


500
InternalServerError


get/v1/projects/{projectId}/conversation/apps/{conversationAppId}/messenger
Request samples 
Response samples 
application/json
{
  • "status": "ACTIVE",
  • "statusDescription": "string",
  • "id": "string",
  • "name": "string",
  • "globalBrandPageName": "string"
}
Get Telegram Bot channel information Closed Beta 
Returns the information for a Telegram Bot channel linked to a Conversation API App.



SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
conversationAppId
required
string
The unique ID of the app. You can find this on the Sinch Dashboard.


 
Responses 
200
Telegram Bot information.


Response Schema: application/json
status
required
string
Channel integration status.


 Enum: "ACTIVE" "ERROR" "FAILING" "PENDING" "UNRECOGNIZED"  
statusDescription
string
Channel integration description if status is ERROR or FAILED.


 
name
string
Name of the bot.


 
username
string
Username of the bot.


 
canJoinGroups
boolean
If the bot can be invited to groups.


 
canReadAllGroupMessages
boolean
If privacy mode is disabled for the bot.


 
supportsInlineQueries
boolean
If the bot supports inline queries.


 
400
BadRequest


401
Unauthorized


404
NotFound


500
InternalServerError


get/v1/projects/{projectId}/conversation/apps/{conversationAppId}/telegram
Request samples 
Response samples 
application/json
The information for the Telegram sender connected to the Conversation API App.



{
  • "status": "ACTIVE",
  • "name": "Sinch",
  • "username": "sinch_bot",
  • "canJoinGroups": true,
  • "canReadAllGroupMessages": false,
  • "supportsInlineQueries": false
}
Get Viber Bot channel information Closed Beta 
Returns the information for a Viber Bot channel linked to a Conversation API App.



SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
conversationAppId
required
string
The unique ID of the app. You can find this on the Sinch Dashboard.


 
Responses 
200
Viber Bot information.


Response Schema: application/json
status
required
string
Channel integration status.


 Enum: "ACTIVE" "ERROR" "FAILING" "PENDING" "UNRECOGNIZED"  
statusDescription
string
Channel integration description if status is ERROR or FAILED.


 
id
string
Account ID


 
name
string
Account name


 
uri
string
Account URI


 
icon
string
Account icon URI


 
category
string
Account category


 
subcategory
string
Account subcategory


 
object
Account location


 
country
string
Account country name (long)


 
subscribersCount
number
Account subscribers count


 
401
Unauthorized


404
NotFound


500
InternalServerError


get/v1/projects/{projectId}/conversation/apps/{conversationAppId}/viber
Request samples 
Response samples 
application/json
{
  • "status": "ACTIVE",
  • "statusDescription": "string",
  • "id": "string",
  • "name": "string",
  • "uri": "string",
  • "icon": "string",
  • "category": "string",
  • "subcategory": "string",
  • "location": {
    • "lon": 0,
    • "lat": 0
    },
  • "country": "string",
  • "subscribersCount": 0
}
SecurityPrivacyLegal & ComplianceCookie Statement
© 2025 Sinch. All rights reserved.