Skip to content

Provisioning API (1.2.16)

Download OpenAPI description
Languages
Servers
Production server
https://provisioning.api.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

Bundles

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

Operations

Conversation

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

Operations

WhatsApp

The WhatsApp endpoint allows you to programmatically log in to and get details of your WhatsApp account.

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

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 Accounts

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

Operations

WhatsApp Flows

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

Operations

WhatsApp Solutions

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

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

KakaoTalk Categories

The KakoaTalk 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

RCS Accounts

The RCS endpoint offers you a way to manage your RCS accounts.

Operations

RCS Questionnaire

Manage your RCS questionnaires.

Operations

RCS Senders

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

Operations

Get sender for projectGA

Request

Returns a sender for a project.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

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

senderIdstringrequired

The unique ID of the sender.

curl -i -X GET \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/rcs/senders/{senderId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sender

Bodyapplication/json
idstringrequired

The unique ID of the sender.

regionstringrequired
Enum"BR""EU""US"
billingCategorystringrequired
Enum"BASIC_MESSAGE""CONVERSATIONAL""CONVERSATIONAL_LEGACY""SINGLE_MESSAGE"
useCasestringrequired
Enum"MULTIUSE""OTP""PROMOTIONAL""TRANSACTIONAL"
hostingRegionstringrequired
Enum"ASIA_PACIFIC""EUROPE""NORTH_AMERICA"
conversationApiAppDetailsobject
statestring
Enum"DRAFT""IN_PROGRESS""IN_TEST""LAUNCHED""LAUNCHING""PREPARING_LAUNCH""UNLAUNCHED""UNKNOWN"
testNumberStatesArray of objects(RcsTestNumberStateDto)

Test phone numbers states.

countryStatusArray of objects(RcsCountryStatusDto)

Countries status.

detailsobject
authNamestring

The name is needed to connect the sender to a Conversation API App.

authTokenstring

The token is needed to connect the sender to a Conversation API App.

createdstring

The UTC Date Time in ISO 8601 for when the sender was created.

modifiedstring

The UTC Date Time in ISO 8601 for when the sender was last modified.

supplierDetailsobject
launchedstring

The UTC Date Time in ISO 8601 for when the sender was last launched.

conversationApiAppstringDeprecated

If set, the Conversation API App ID the sender is connected to.

Response
application/json

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": {} } }

Update sender for projectGA

Request

Returns updated sender for a project.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

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

senderIdstringrequired
Bodyapplication/jsonrequired

Sender data update

detailsobjectrequired
details.​brandobject
details.​testNumbersArray of strings or null(e.164 phone number)<= 200 itemsunique

Phone numbers for testing. An agent can send 20 tester requests each day with a total maximum of 200 tester requests. If null the value will be deleted.

details.​countriesArray of strings or null(RcsInputCountryCodes)non-emptyunique

List of two-letter country codes in ISO 3166 standard, specifying the countries to launch RCS sender in. If null the value will be deleted.

Enum"AT""BE""BR""CA""CZ""DK""FI""FR""DE""IT"
details.​questionnaireobject
curl -i -X PATCH \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/rcs/senders/{senderId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
          }
        }
      }
    }
  }'

Responses

Sender

Bodyapplication/json
idstringrequired

The unique ID of the sender.

regionstringrequired
Enum"BR""EU""US"
billingCategorystringrequired
Enum"BASIC_MESSAGE""CONVERSATIONAL""CONVERSATIONAL_LEGACY""SINGLE_MESSAGE"
useCasestringrequired
Enum"MULTIUSE""OTP""PROMOTIONAL""TRANSACTIONAL"
hostingRegionstringrequired
Enum"ASIA_PACIFIC""EUROPE""NORTH_AMERICA"
conversationApiAppDetailsobject
statestring
Enum"DRAFT""IN_PROGRESS""IN_TEST""LAUNCHED""LAUNCHING""PREPARING_LAUNCH""UNLAUNCHED""UNKNOWN"
testNumberStatesArray of objects(RcsTestNumberStateDto)

Test phone numbers states.

countryStatusArray of objects(RcsCountryStatusDto)

Countries status.

detailsobject
authNamestring

The name is needed to connect the sender to a Conversation API App.

authTokenstring

The token is needed to connect the sender to a Conversation API App.

createdstring

The UTC Date Time in ISO 8601 for when the sender was created.

modifiedstring

The UTC Date Time in ISO 8601 for when the sender was last modified.

supplierDetailsobject
launchedstring

The UTC Date Time in ISO 8601 for when the sender was last launched.

conversationApiAppstringDeprecated

If set, the Conversation API App ID the sender is connected to.

Response
application/json

Response when successfully updated 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": {} } }

Lists activities on senderGA

Request

Paginated list of activities for sender. Ordered from the most recent one to the oldest one.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

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

senderIdstringrequired

The unique ID of the sender.

Query
pageTokenstring

The page token if retrieving the next page from a previous query.

pageSizenumber[ 1 .. 100 ]

The page size requested.

curl -i -X GET \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/rcs/senders/{senderId}/activities?pageToken=string&pageSize=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Recent activities on sender

Bodyapplication/json
totalSizenumberrequired

Total size of the entries matching the search query.

pageSizenumberrequired

Requested size of the page.

notificationsArray of objects(RcsSenderNotificationDto)required
notifications[].​typestringrequired
Enum"ACTIVE""COMMENT_ADDED""CREATED""DELETED""EDITED""INACTIVE""TEST"
notifications[].​createdstring
notifications[].​authorstring
notifications[].​commentstring
previousPageTokenstring

Encoded token to use in list request to fetch previous batch of entries.

nextPageTokenstring

Encoded token to use in list request to fetch next batch of entries.

Response
application/json

Response for all sender activities.

{ "totalSize": 2, "pageSize": 50, "notifications": [ {}, {} ] }