Apps are created and configured through the Sinch Dashboard, are tied to the API user and come with a set of channel credentials for each underlying connected channel. The app has a list of conversations between itself and different contacts which share the same project.
Webhooks, which the app is attached to, defines the destination for various events coming from the Conversation API. An app has the following configurable properties:
Field | Description |
---|---|
Display name | The name visible in the Sinch Dashboard. |
Conversation metadata report | Specifies the amount of conversationmetadata that's returned as part of each callback. |
Retention Policy | The retention policy specifies how long messages, sent to or from an app, are stored by the Conversation API. |
Get a list of all apps in the specified project.
project_id required | string The unique ID of the project. You can find this on the Sinch Dashboard. |
A successful response.
Array of objects (Conversation API app) List of apps belonging to a specific project ID. | |||||||||||||||||||||||||||
Array
|
Malformed request
Incorrect credentials
Correct credentials but you don't have access to the requested resource
Correct credentials but you don't have access to the requested resource
Something went wrong on our end, try again with exponential back-off
{- "apps": [
- {
- "channel_credentials": [
- {
- "callback_secret": "string",
- "channel": "WHATSAPP",
- "mms_credentials": {
- "account_id": "string",
- "api_key": "string",
- "basic_auth": {
- "password": "string",
- "username": "string"
}
}, - "kakaotalk_credentials": {
- "kakaotalk_plus_friend_id": "string",
- "kakaotalk_sender_key": "string"
}, - "static_bearer": {
- "claimed_identity": "string",
- "token": "string"
}, - "static_token": {
- "token": "string"
}, - "telegram_credentials": {
- "token": "{{TELEGRAM_BOT_TOKEN}}"
}, - "line_credentials": {
- "token": "{{LINE_TOKEN}}",
- "secret": "{{LINE_SECRET}}"
}, - "wechat_credentials": {
- "app_id": "{{WECHAT_APPID}}",
- "app_secret": "{{WECHAT_APPSECRET}}",
- "token": "{{WECHAT_TOKEN}}",
- "aes_key": "{{WECHAT_AESKEY}}"
}
}
], - "conversation_metadata_report_view": "NONE",
- "display_name": "Sinch Conversation API Demo App 001",
- "id": "{APP_ID}",
- "rate_limits": {
- "inbound": 0,
- "outbound": 0,
- "webhooks": 0
}, - "retention_policy": {
- "retention_type": "MESSAGE_EXPIRE_POLICY",
- "ttl_days": 180
}, - "dispatch_retention_policy": {
- "retention_type": "MESSAGE_EXPIRE_POLICY",
- "ttl_days": 0
}, - "processing_mode": "CONVERSATION",
- "smart_conversation": {
- "enabled": false
}, - "queue_stats": {
- "outbound_size": 0,
- "outbound_limit": 0
}
}
]
}
You can create a new Conversation API app using the API. You can create an app for one or more channels at once. The ID of the app is generated at creation and will be returned in the response.
project_id required | string The unique ID of the project. You can find this on the Sinch Dashboard. |
The app to create.
display_name required | string The display name for the app. | ||||||
required | Array of objects (Channel Credential) An array of channel credentials. The order of the credentials defines the app channel priority. | ||||||
conversation_metadata_report_view | string (ConversationMetadataReportView) Enum: "NONE" "FULL" | ||||||
object (RetentionPolicy) The retention policy configured for the app. For more information about retention policies, see Retention Policy. | |||||||
object (DispatchRetentionPolicy) The retention policy configured for messages in Dispatch Mode. Currently only | |||||||
processing_mode | string (ProcessingMode) Whether or not Conversation API should store contacts and conversations for the app. For more information, see Processing Modes.
| ||||||
object (SmartConversation) This object is required for apps that subscribe to Smart Conversations features. Note that this functionality is available for open beta testing. |
A successful response.
Array of objects (Channel Credential) An array of channel credentials. The order of the credentials defines the app channel priority. | |||||||
conversation_metadata_report_view | string (ConversationMetadataReportView) Enum: "NONE" "FULL" | ||||||
display_name | string The display name for the app. | ||||||
id | string The ID of the app. You can find this on the Sinch Dashboard. | ||||||
object (RateLimits) | |||||||
object (RetentionPolicy) The retention policy configured for the app. For more information about retention policies, see Retention Policy. | |||||||
object (DispatchRetentionPolicy) The retention policy configured for messages in Dispatch Mode. Currently only | |||||||
processing_mode | string (ProcessingMode) Whether or not Conversation API should store contacts and conversations for the app. For more information, see Processing Modes.
| ||||||
object (SmartConversation) This object is required for apps that subscribe to Smart Conversations features. Note that this functionality is available for open beta testing. | |||||||
object (QueueStats) |
Malformed request
Incorrect credentials
Correct credentials but you don't have access to the requested resource
Correct credentials but you don't have access to the requested resource
Something went wrong on our end, try again with exponential back-off
{- "channel_credentials": [
- {
- "channel": "MESSENGER",
- "static_token": {
- "token": "{Facebook_Token}"
}
}
], - "display_name": "Demo Facebook App"
}
{- "channel_credentials": [
- {
- "callback_secret": "string",
- "channel": "WHATSAPP",
- "mms_credentials": {
- "account_id": "string",
- "api_key": "string",
- "basic_auth": {
- "password": "string",
- "username": "string"
}
}, - "kakaotalk_credentials": {
- "kakaotalk_plus_friend_id": "string",
- "kakaotalk_sender_key": "string"
}, - "static_bearer": {
- "claimed_identity": "string",
- "token": "string"
}, - "static_token": {
- "token": "string"
}, - "telegram_credentials": {
- "token": "{{TELEGRAM_BOT_TOKEN}}"
}, - "line_credentials": {
- "token": "{{LINE_TOKEN}}",
- "secret": "{{LINE_SECRET}}"
}, - "wechat_credentials": {
- "app_id": "{{WECHAT_APPID}}",
- "app_secret": "{{WECHAT_APPSECRET}}",
- "token": "{{WECHAT_TOKEN}}",
- "aes_key": "{{WECHAT_AESKEY}}"
}
}
], - "conversation_metadata_report_view": "NONE",
- "display_name": "Sinch Conversation API Demo App 001",
- "id": "{APP_ID}",
- "rate_limits": {
- "inbound": 0,
- "outbound": 0,
- "webhooks": 0
}, - "retention_policy": {
- "retention_type": "MESSAGE_EXPIRE_POLICY",
- "ttl_days": 180
}, - "dispatch_retention_policy": {
- "retention_type": "MESSAGE_EXPIRE_POLICY",
- "ttl_days": 0
}, - "processing_mode": "CONVERSATION",
- "smart_conversation": {
- "enabled": false
}, - "queue_stats": {
- "outbound_size": 0,
- "outbound_limit": 0
}
}
Returns a particular app as specified by the App ID.
project_id required | string The unique ID of the project. You can find this on the Sinch Dashboard. |
app_id required | string The unique ID of the app. You can find this on the Sinch Dashboard. |
A successful response.
Array of objects (Channel Credential) An array of channel credentials. The order of the credentials defines the app channel priority. | |||||||
conversation_metadata_report_view | string (ConversationMetadataReportView) Enum: "NONE" "FULL" | ||||||
display_name | string The display name for the app. | ||||||
id | string The ID of the app. You can find this on the Sinch Dashboard. | ||||||
object (RateLimits) | |||||||
object (RetentionPolicy) The retention policy configured for the app. For more information about retention policies, see Retention Policy. | |||||||
object (DispatchRetentionPolicy) The retention policy configured for messages in Dispatch Mode. Currently only | |||||||
processing_mode | string (ProcessingMode) Whether or not Conversation API should store contacts and conversations for the app. For more information, see Processing Modes.
| ||||||
object (SmartConversation) This object is required for apps that subscribe to Smart Conversations features. Note that this functionality is available for open beta testing. | |||||||
object (QueueStats) |
Malformed request
Incorrect credentials
Correct credentials but you don't have access to the requested resource
Correct credentials but you don't have access to the requested resource
Something went wrong on our end, try again with exponential back-off
{- "channel_credentials": [
- {
- "callback_secret": "string",
- "channel": "WHATSAPP",
- "mms_credentials": {
- "account_id": "string",
- "api_key": "string",
- "basic_auth": {
- "password": "string",
- "username": "string"
}
}, - "kakaotalk_credentials": {
- "kakaotalk_plus_friend_id": "string",
- "kakaotalk_sender_key": "string"
}, - "static_bearer": {
- "claimed_identity": "string",
- "token": "string"
}, - "static_token": {
- "token": "string"
}, - "telegram_credentials": {
- "token": "{{TELEGRAM_BOT_TOKEN}}"
}, - "line_credentials": {
- "token": "{{LINE_TOKEN}}",
- "secret": "{{LINE_SECRET}}"
}, - "wechat_credentials": {
- "app_id": "{{WECHAT_APPID}}",
- "app_secret": "{{WECHAT_APPSECRET}}",
- "token": "{{WECHAT_TOKEN}}",
- "aes_key": "{{WECHAT_AESKEY}}"
}
}
], - "conversation_metadata_report_view": "NONE",
- "display_name": "Sinch Conversation API Demo App 001",
- "id": "{APP_ID}",
- "rate_limits": {
- "inbound": 0,
- "outbound": 0,
- "webhooks": 0
}, - "retention_policy": {
- "retention_type": "MESSAGE_EXPIRE_POLICY",
- "ttl_days": 180
}, - "dispatch_retention_policy": {
- "retention_type": "MESSAGE_EXPIRE_POLICY",
- "ttl_days": 0
}, - "processing_mode": "CONVERSATION",
- "smart_conversation": {
- "enabled": false
}, - "queue_stats": {
- "outbound_size": 0,
- "outbound_limit": 0
}
}
Deletes a particular app as specified by the App ID.
project_id required | string The unique ID of the project. You can find this on the Sinch Dashboard. |
app_id required | string The unique ID of the app. You can find this on the Sinch Dashboard. |
A successful response.
Malformed request
Incorrect credentials
Correct credentials but you don't have access to the requested resource
Correct credentials but you don't have access to the requested resource
Something went wrong on our end, try again with exponential back-off
null
Updates a particular app as specified by the App ID.
project_id required | string The unique ID of the project. You can find this on the Sinch Dashboard. |
app_id required | string The unique ID of the app. You can find this on the Sinch Dashboard. |
The updated app.
display_name required | string The display name for the app. | ||||||
Array of objects (Channel Credential) An array of channel credentials. The order of the credentials defines the app channel priority. | |||||||
conversation_metadata_report_view | string (ConversationMetadataReportView) Enum: "NONE" "FULL" | ||||||
object (RetentionPolicy) The retention policy configured for the app. For more information about retention policies, see Retention Policy. | |||||||
object (DispatchRetentionPolicy) The retention policy configured for messages in Dispatch Mode. Currently only | |||||||
processing_mode | string (ProcessingMode) Whether or not Conversation API should store contacts and conversations for the app. For more information, see Processing Modes.
| ||||||
object (SmartConversation) This object is required for apps that subscribe to Smart Conversations features. Note that this functionality is available for open beta testing. |
A successful response.
Array of objects (Channel Credential) An array of channel credentials. The order of the credentials defines the app channel priority. | |||||||
conversation_metadata_report_view | string (ConversationMetadataReportView) Enum: "NONE" "FULL" | ||||||
display_name | string The display name for the app. | ||||||
id | string The ID of the app. You can find this on the Sinch Dashboard. | ||||||
object (RateLimits) | |||||||
object (RetentionPolicy) The retention policy configured for the app. For more information about retention policies, see Retention Policy. | |||||||
object (DispatchRetentionPolicy) The retention policy configured for messages in Dispatch Mode. Currently only | |||||||
processing_mode | string (ProcessingMode) Whether or not Conversation API should store contacts and conversations for the app. For more information, see Processing Modes.
| ||||||
object (SmartConversation) This object is required for apps that subscribe to Smart Conversations features. Note that this functionality is available for open beta testing. | |||||||
object (QueueStats) |
Malformed request
Incorrect credentials
Correct credentials but you don't have access to the requested resource
Correct credentials but you don't have access to the requested resource
Something went wrong on our end, try again with exponential back-off
{- "channel_credentials": [
- {
- "channel": "WHATSAPP",
- "static_bearer": {
- "claimed_identity": "{{WhatsApp_Sender_Id}}",
- "token": "{{WhatsApp_Bearer_Token}}"
}, - "callback_secret": "{{Callback_Secret_1}}"
}, - {
- "channel": "MESSENGER",
- "static_token": {
- "token": "{{Facebook_Token}}"
}, - "callback_secret": "{{Callback_Secret_2}}"
}, - {
- "channel": "SMS",
- "static_bearer": {
- "claimed_identity": "{{Service_Plan_Id}}",
- "token": "{{API_Token}}"
}
}
], - "display_name": "New App Display Name"
}
{- "channel_credentials": [
- {
- "callback_secret": "string",
- "channel": "WHATSAPP",
- "mms_credentials": {
- "account_id": "string",
- "api_key": "string",
- "basic_auth": {
- "password": "string",
- "username": "string"
}
}, - "kakaotalk_credentials": {
- "kakaotalk_plus_friend_id": "string",
- "kakaotalk_sender_key": "string"
}, - "static_bearer": {
- "claimed_identity": "string",
- "token": "string"
}, - "static_token": {
- "token": "string"
}, - "telegram_credentials": {
- "token": "{{TELEGRAM_BOT_TOKEN}}"
}, - "line_credentials": {
- "token": "{{LINE_TOKEN}}",
- "secret": "{{LINE_SECRET}}"
}, - "wechat_credentials": {
- "app_id": "{{WECHAT_APPID}}",
- "app_secret": "{{WECHAT_APPSECRET}}",
- "token": "{{WECHAT_TOKEN}}",
- "aes_key": "{{WECHAT_AESKEY}}"
}
}
], - "conversation_metadata_report_view": "NONE",
- "display_name": "Sinch Conversation API Demo App 001",
- "id": "{APP_ID}",
- "rate_limits": {
- "inbound": 0,
- "outbound": 0,
- "webhooks": 0
}, - "retention_policy": {
- "retention_type": "MESSAGE_EXPIRE_POLICY",
- "ttl_days": 180
}, - "dispatch_retention_policy": {
- "retention_type": "MESSAGE_EXPIRE_POLICY",
- "ttl_days": 0
}, - "processing_mode": "CONVERSATION",
- "smart_conversation": {
- "enabled": false
}, - "queue_stats": {
- "outbound_size": 0,
- "outbound_limit": 0
}
}