The WhatsApp accounts endpoint lets you create and update WhatsApp accounts as well as get account activity and leave comments.
Provisioning API (1.2.36)
A WhatsApp Sender is also referred to as a 'Business Profile' or a WhatsApp channel. The WhatsApp Sender endpoint allows you to create a Sender through Meta's Embedded sign up. A Sender must be provisioned for you as a consumer of the WhatsApp API to send messages to your end users.
Request
Returns a paginated list of senders for the specified project. If no page token is supplied then the first 50 will be returned.
The unique ID of the project. You can find this on the Sinch Dashboard.
- Production serverhttps://provisioning.api.sinch.com/v1/projects/{projectId}/rcs/senders
- Staging server from master branchhttps://provisioning-api.int.staging.sinch.com/v1/projects/{projectId}/rcs/senders
- Staging server from dev branchhttps://provisioning-api-dev.int.staging.sinch.com/v1/projects/{projectId}/rcs/senders
- Internal production server for admin authorizationhttps://provisioning-api.unauth.int.prod.sinch.com/v1/projects/{projectId}/rcs/senders
- Internal staging server from master branch for admin authorizationhttps://provisioning-api.unauth.int.staging.sinch.com/v1/projects/{projectId}/rcs/senders
- Internal staging server from dev branch for admin authorizationhttps://provisioning-api-dev.unauth.int.staging.sinch.com/v1/projects/{projectId}/rcs/senders
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://provisioning.api.sinch.com/v1/projects/{projectId}/rcs/senders?pageToken=string&pageSize=1&filterConversationApiAppId=string&filterSenderIds=string&filterStates=DRAFT&search=string&sortColumn=CREATED&sortDirection=ASC&filterSenderName=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'List of senders
List of senders.
Billing category. Note: The billing framework distinguishes between two primary categories: non-conversational and conversational. The non-conversational category includes SINGLE_MESSAGE and BASIC_MESSAGE types which are considered functionally equivalent in the current revision. The conversational category includes CONVERSATIONAL and CONVERSATIONAL_LEGACY types. Values BASIC_MESSAGE, SINGLE_MESSAGE and CONVERSATIONAL_LEGACY are deprecated and will be removed in a future version.
- CONVERSATIONAL: Designed for longer, more complex sessions where the user and brand exchange a series of messages.
- NON_CONVERSATIONAL: Represents a non-conversational billing category, which replaces the legacy SINGLE_MESSAGE and BASIC_MESSAGE categories. This is for agents that primarily engage in one-way (A2P) communication.
- BASIC_MESSAGE: Billing model is similar to SMS. Deprecated value, use NON_CONVERSATIONAL instead.
- CONVERSATIONAL_LEGACY: Legacy category to support the billing configuration of existing agents. Deprecated value, use CONVERSATIONAL instead.
- SINGLE_MESSAGE: Replaces SMS with a richer messaging experience. Deprecated value, use NON_CONVERSATIONAL instead.
Internal Google hosting region
If set, the details of the Conversation API App the sender is connected to.
The current state of the sender.
{ "totalSize": 2, "pageSize": 50, "senders": [ { … }, { … } ] }
The unique ID of the project. You can find this on the Sinch Dashboard.
Sender data
Billing category. Note: The billing framework distinguishes between two primary categories: non-conversational and conversational. The non-conversational category includes SINGLE_MESSAGE and BASIC_MESSAGE types which are considered functionally equivalent in the current revision. The conversational category includes CONVERSATIONAL and CONVERSATIONAL_LEGACY types. Values BASIC_MESSAGE, SINGLE_MESSAGE and CONVERSATIONAL_LEGACY are deprecated and will be removed in a future version.
- CONVERSATIONAL: Designed for longer, more complex sessions where the user and brand exchange a series of messages.
- NON_CONVERSATIONAL: Represents a non-conversational billing category, which replaces the legacy SINGLE_MESSAGE and BASIC_MESSAGE categories. This is for agents that primarily engage in one-way (A2P) communication.
- BASIC_MESSAGE: Billing model is similar to SMS. Deprecated value, use NON_CONVERSATIONAL instead.
- CONVERSATIONAL_LEGACY: Legacy category to support the billing configuration of existing agents. Deprecated value, use CONVERSATIONAL instead.
- SINGLE_MESSAGE: Replaces SMS with a richer messaging experience. Deprecated value, use NON_CONVERSATIONAL instead.
- Production serverhttps://provisioning.api.sinch.com/v1/projects/{projectId}/rcs/senders
- Staging server from master branchhttps://provisioning-api.int.staging.sinch.com/v1/projects/{projectId}/rcs/senders
- Staging server from dev branchhttps://provisioning-api-dev.int.staging.sinch.com/v1/projects/{projectId}/rcs/senders
- Internal production server for admin authorizationhttps://provisioning-api.unauth.int.prod.sinch.com/v1/projects/{projectId}/rcs/senders
- Internal staging server from master branch for admin authorizationhttps://provisioning-api.unauth.int.staging.sinch.com/v1/projects/{projectId}/rcs/senders
- Internal staging server from dev branch for admin authorizationhttps://provisioning-api-dev.unauth.int.staging.sinch.com/v1/projects/{projectId}/rcs/senders
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://provisioning.api.sinch.com/v1/projects/{projectId}/rcs/senders' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"region": "EU",
"billingCategory": "CONVERSATIONAL",
"useCase": "OTP",
"details": {
"brand": {
"emails": [
{
"label": "label",
"address": "test@test.com"
},
{
"label": "label-1",
"address": "test-1@test.com"
},
{
"label": "label-2",
"address": "test-2@test.com"
}
],
"phones": [
{
"label": "label",
"number": "+48777777777"
},
{
"label": "label-1",
"number": "48888888888"
},
{
"label": "label-2",
"number": "+48999999999"
}
],
"websites": [
{
"label": "label",
"url": "https://example.com"
},
{
"label": "label-1",
"url": "https://example-1.com"
},
{
"label": "label-2",
"url": "https://example-2.com"
}
],
"color": "#000000",
"description": "Test description",
"bannerUrl": "https://example-banner-url.com",
"logoUrl": "https://example-logo-url.com",
"privacyPolicyUrl": "https://example-private-policy-url.com",
"termsOfServiceUrl": "https://example-terms-of-service-url.com",
"name": "Test name"
},
"testNumbers": [
"+48777777777"
],
"countries": [
"GB",
"FR"
],
"questionnaire": {
"general": {
"answers": {
"optInDescription": "By subscribing to a newsletter",
"triggerDescription": "User actions (e.g. after making a purchase)",
"interactionsDescription": "Billing or payment reminders,aef Order updates,aef Upon package delivery",
"interactionsDescriptionMetadata": {
"ignore": ",aef"
},
"optOutDescription": "We have registered your opt out request",
"videoUris": [
"https://example-video-url.com"
],
"screenshotUris": [
"https://example-screenshot-url.com"
]
}
},
"verification": {
"answers": {
"name": "Exam Ple",
"email": "email@example.com",
"title": "Head Example",
"website": "https://example.com"
}
},
"gb": {
"answers": {
"brandIndustry": "Automotive",
"companyLegalName": "Example company legal name",
"companyRegistrationNumber": "123-123456789",
"fullCompanyAddress": "Skeppsbron 1 Malmö, 123 12, Sweden",
"messagesVolume": "10K - 100K messages",
"messagesFrequency": "Once per month"
}
},
"fr": {
"answers": {
"fullCompanyAddress": "Skeppsbron 1-split-211 20-split-Malmö",
"fullCompanyAddressMetadata": {
"ignore": "-split-"
},
"siren": "123456789"
}
}
}
}
}'Sender
Billing category. Note: The billing framework distinguishes between two primary categories: non-conversational and conversational. The non-conversational category includes SINGLE_MESSAGE and BASIC_MESSAGE types which are considered functionally equivalent in the current revision. The conversational category includes CONVERSATIONAL and CONVERSATIONAL_LEGACY types. Values BASIC_MESSAGE, SINGLE_MESSAGE and CONVERSATIONAL_LEGACY are deprecated and will be removed in a future version.
- CONVERSATIONAL: Designed for longer, more complex sessions where the user and brand exchange a series of messages.
- NON_CONVERSATIONAL: Represents a non-conversational billing category, which replaces the legacy SINGLE_MESSAGE and BASIC_MESSAGE categories. This is for agents that primarily engage in one-way (A2P) communication.
- BASIC_MESSAGE: Billing model is similar to SMS. Deprecated value, use NON_CONVERSATIONAL instead.
- CONVERSATIONAL_LEGACY: Legacy category to support the billing configuration of existing agents. Deprecated value, use CONVERSATIONAL instead.
- SINGLE_MESSAGE: Replaces SMS with a richer messaging experience. Deprecated value, use NON_CONVERSATIONAL instead.
If set, the details of the Conversation API App the sender is connected to.
The current state of the sender.
{ "id": "cf11794a-6a5e-4a12-b103-da79bd378bf1", "state": "IN_TEST", "testNumberStates": [ { … }, { … }, { … } ], "countryStatus": [ { … }, { … }, { … } ], "details": { "brand": { … }, "testNumbers": [ … ], "countries": [ … ], "questionnaire": { … } }, "region": "EU", "billingCategory": "CONVERSATIONAL", "useCase": "OTP", "hostingRegion": "EUROPE", "authName": "yurwN6123asd", "authToken": "ejiiqJtDyurwN6jLze8v", "conversationApiApp": "4CF9CE97504C4A468F4610919D17ECC1", "conversationApiAppDetails": { "id": "4CF9CE97504C4A468F4610919D17ECC1", "projectId": "ea026751-3edf-40a9-ad93-1b382bd60a78", "region": "EU" }, "created": "2023-01-19t13:11:08.204Z", "modified": "2023-01-19t13:11:08.204Z", "launched": "2023-01-19t13:11:08.204Z", "supplierDetails": { "google": { … } }, "brand": { "id": "eceed77f-22f6-42bc-b2ce-3fe65916028e", "status": "DRAFT", "registrations": [ … ] } }
The unique ID of the project. You can find this on the Sinch Dashboard.
- Production serverhttps://provisioning.api.sinch.com/v1/projects/{projectId}/rcs/senders/{senderId}
- Staging server from master branchhttps://provisioning-api.int.staging.sinch.com/v1/projects/{projectId}/rcs/senders/{senderId}
- Staging server from dev branchhttps://provisioning-api-dev.int.staging.sinch.com/v1/projects/{projectId}/rcs/senders/{senderId}
- Internal production server for admin authorizationhttps://provisioning-api.unauth.int.prod.sinch.com/v1/projects/{projectId}/rcs/senders/{senderId}
- Internal staging server from master branch for admin authorizationhttps://provisioning-api.unauth.int.staging.sinch.com/v1/projects/{projectId}/rcs/senders/{senderId}
- Internal staging server from dev branch for admin authorizationhttps://provisioning-api-dev.unauth.int.staging.sinch.com/v1/projects/{projectId}/rcs/senders/{senderId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://provisioning.api.sinch.com/v1/projects/{projectId}/rcs/senders/{senderId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Sender
Billing category. Note: The billing framework distinguishes between two primary categories: non-conversational and conversational. The non-conversational category includes SINGLE_MESSAGE and BASIC_MESSAGE types which are considered functionally equivalent in the current revision. The conversational category includes CONVERSATIONAL and CONVERSATIONAL_LEGACY types. Values BASIC_MESSAGE, SINGLE_MESSAGE and CONVERSATIONAL_LEGACY are deprecated and will be removed in a future version.
- CONVERSATIONAL: Designed for longer, more complex sessions where the user and brand exchange a series of messages.
- NON_CONVERSATIONAL: Represents a non-conversational billing category, which replaces the legacy SINGLE_MESSAGE and BASIC_MESSAGE categories. This is for agents that primarily engage in one-way (A2P) communication.
- BASIC_MESSAGE: Billing model is similar to SMS. Deprecated value, use NON_CONVERSATIONAL instead.
- CONVERSATIONAL_LEGACY: Legacy category to support the billing configuration of existing agents. Deprecated value, use CONVERSATIONAL instead.
- SINGLE_MESSAGE: Replaces SMS with a richer messaging experience. Deprecated value, use NON_CONVERSATIONAL instead.
If set, the details of the Conversation API App the sender is connected to.
The current state of the sender.
- inTest
- preparingLaunch
- launching
{ "id": "cf11794a-6a5e-4a12-b103-da79bd378bf1", "state": "IN_TEST", "testNumberStates": [ { … }, { … }, { … } ], "countryStatus": [ { … }, { … }, { … } ], "details": { "brand": { … }, "testNumbers": [ … ], "countries": [ … ], "questionnaire": { … } }, "region": "EU", "billingCategory": "CONVERSATIONAL", "useCase": "OTP", "hostingRegion": "EUROPE", "authName": "yurwN6123asd", "authToken": "ejiiqJtDyurwN6jLze8v", "conversationApiApp": "4CF9CE97504C4A468F4610919D17ECC1", "conversationApiAppDetails": { "id": "4CF9CE97504C4A468F4610919D17ECC1", "projectId": "ea026751-3edf-40a9-ad93-1b382bd60a78", "region": "EU" }, "created": "2023-01-19t13:11:08.204Z", "modified": "2023-01-19t13:11:08.204Z", "launched": "2023-01-19t13:11:08.204Z", "supplierDetails": { "google": { … } }, "brand": { "id": "eceed77f-22f6-42bc-b2ce-3fe65916028e", "status": "DRAFT", "registrations": [ … ] } }