The bundles endpoint allows you to create and manage bundles of account resources.
Provisioning API (1.2.7)
https://provisioning.api.sinch.com/
WhatsApp Senders
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.
The unique ID of the project. You can find this on the Sinch Dashboard.
- Production server
https://provisioning.api.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&filterSenderName=string&filterStates=DRAFT&sortColumn=CREATED&sortDirection=ASC' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'List of senders
List of senders.
Billing category.
Internal Google hosting region
If set, the details of the Conversation API App the sender is connected to.
The current state of the sender.
Response with senders.
{ "totalSize": 2, "pageSize": 50, "senders": [ { … }, { … } ] }
The unique ID of the project. You can find this on the Sinch Dashboard.
Sender data
Billing category.
- Production server
https://provisioning.api.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_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"region": "EU",
"billingCategory": "BASIC_MESSAGE",
"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": "+48 777-777-777"
},
{
"label": "label-1",
"number": "48888888888"
},
{
"label": "label-2",
"number": "+48 999-999-999"
}
],
"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": [
"+48 777-777-777"
],
"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.
If set, the details of the Conversation API App the sender is connected to.
The current state of the sender.
Response when successfully creating a sender.
{ "id": "cf11794a-6a5e-4a12-b103-da79bd378bf1", "state": "IN_TEST", "testNumberStates": [ { … }, { … }, { … } ], "countryStatus": [ { … }, { … }, { … } ], "details": { "brand": { … }, "testNumbers": [ … ], "countries": [ … ], "questionnaire": { … } }, "region": "EU", "billingCategory": "BASIC_MESSAGE", "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": { … } } }
The unique ID of the project. You can find this on the Sinch Dashboard.
- Production server
https://provisioning.api.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_JWT_HERE>'Sender
Billing category.
If set, the details of the Conversation API App the sender is connected to.
The current state of the sender.
Response with a sender inTest.
{ "id": "cf11794a-6a5e-4a12-b103-da79bd378bf1", "state": "IN_TEST", "testNumberStates": [ { … }, { … }, { … } ], "countryStatus": [ { … }, { … }, { … } ], "details": { "brand": { … }, "testNumbers": [ … ], "countries": [ … ], "questionnaire": { … } }, "region": "EU", "billingCategory": "BASIC_MESSAGE", "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": { … } } }