Skip to content
Provisioning API/
/WhatsApp

Provisioning API (1.2.36)

Download OpenAPI description
provisioning-api.json
provisioning-api.yaml
Languages
Servers
Production server
https://provisioning.api.sinch.com
Staging server from master branch
https://provisioning-api.int.staging.sinch.com
Staging server from dev branch
https://provisioning-api-dev.int.staging.sinch.com
Internal production server for admin authorization
https://provisioning-api.unauth.int.prod.sinch.com
Internal staging server from master branch for admin authorization
https://provisioning-api.unauth.int.staging.sinch.com
Internal staging server from dev branch for admin authorization
https://provisioning-api-dev.unauth.int.staging.sinch.com

Webhooks

Webhooks allow the Sinch servers to communicate with your server backend. The webhooks endpoint lets you create, update, and delete webhooks programmatically.

Operations

WhatsApp Accounts

The WhatsApp accounts endpoint lets you create and update WhatsApp accounts as well as get account activity and leave comments.

Operations

WhatsApp

he WhatsApp endpoint enables programmatic login to your WhatsApp account and retrieval of its details.

Operations

Enable Meta template analyticsGA

Request

Enable Meta template analytics for WhatsApp Business Account.

Security
BasicAuth and BearerAuth and OAuth2Staging and OAuth2Production and OAuth2StagingAdmin and OAuth2ProductionAdmin
Path
projectIdstringrequired

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

curl -i -X PUT \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/whatsapp/enableTemplateAnalytics' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Meta template analytics enabled for WhatsApp Business Account.

Response
No content

Create a long lived access tokenGADeprecated

Request

Returns a long lived access token based on the facebook token from the embedded signup. Valid for 60 days.

Security
BasicAuth and BearerAuth and OAuth2Staging and OAuth2Production and OAuth2StagingAdmin and OAuth2ProductionAdmin
Path
projectIdstringrequired

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

Bodyapplication/jsonrequired

Facebook token generated from the embedded signup process, or another long lived access token.

facebookTokenstringnon-empty

Long-Lived User access token. Mandatory if facebookCode is not provided.

facebookCodestringnon-empty

Single-use access code. Mandatory if facebookToken is not provided.

businessManagerstring

Business manager.

Enum"SINCH_AMERICA""SINCH_BR""SINCH_MX""SINCH_SEP""SINCH_UK"
curl -i -X POST \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/whatsapp/longLivedAccessToken' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "facebookCode": "FACEBOOK_CODE"
  }'

Responses

The long lived access token.

Bodyapplication/json
longLivedAccessTokenstringrequired
Response
application/json
{
  "longLivedAccessToken": "FACEBOOK_TOKEN"
}

List WhatsApp Business Accounts detailsGADeprecated

Request

Returns a list of all the WhatsApp Business Accounts that the facebook token is associated with, together with the numbers that are shared.

Security
BasicAuth and BearerAuth and OAuth2Staging and OAuth2Production and OAuth2StagingAdmin and OAuth2ProductionAdmin
Path
projectIdstringrequired

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

Bodyapplication/jsonrequired

WabaDetails data with Facebook token generated from the embedded signup process.

facebookTokenstringrequired

Long-Lived User access token.

businessManagerstring

Business manager.

Enum"SINCH_AMERICA""SINCH_BR""SINCH_MX""SINCH_SEP""SINCH_UK"
curl -i -X POST \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/whatsapp/wabaDetails' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "facebookToken": "FACEBOOK_TOKEN"
  }'

Responses

List of WhatsApp Business Accounts.

Bodyapplication/json
wabasArray of objects(WhatsappWabaDetailsDto)required
wabas[].​idstringrequired

The id of the WhatsApp Business Account.

wabas[].​numbersArray of objects(WhatsappWabaNumbersDto)required

The numbers that are shared to the WhatsApp Business Account.

wabas[].​numbers[].​idstringrequired

Unique id of the number.

wabas[].​numbers[].​displayPhoneNumberstringrequired

The number displayed in E.164 format.

wabas[].​numbers[].​provisionedbooleanrequired

True if the number is available for usage, false otherwise.

Response
application/json
{
  "wabas": [
    { … }
  ]
}

WhatsApp Flows

The WhatsApp flows endpoint lets you retrieve and manage WhatsApp Flows associated with the project.

Operations

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.

Operations

WhatsApp Solutions

The WhatsApp solutions endpoint offers a way for you to manage your WhatsApp solutions.

Operations

WhatsApp Templates

The WhatsApp template endpoint offers a way for you to manage your WhatsApp templates that can be used with the Conversation API. The WhatsApp templates are a requirement to send the initial outbound messages in the WhatsApp API.

Operations

Bundles

The bundles endpoint allows you to create and manage bundles of account resources.

Operations

KakaoTalk Categories

The KakaoTalk categories endpoint offers a way for you to manage all of the KakaoTalk template categories that you can use with the Conversation API.

Operations

KakaoTalk Senders

The KakaoTalk sender endpoint offers a way for you to manage your KakaoTalk senders that can be used with the Conversation API.

Operations

KakaoTalk Templates

The KakaoTalk template endpoint offers a way for you to manage your KakaoTalk templates that can be used with the Conversation API.

Operations

Conversation

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

Operations

RCS Accounts

Operations

RCS Questionnaire

Operations

RCS Senders

Operations