Skip to content
Provisioning API/
/Bundles

Provisioning API (1.2.7)

Download OpenAPI description
provisioning-api.json
provisioning-api.yaml
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

Create bundle for projectGA

Request

Creates a new bundle of resources based on the input work order.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

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

Bodyapplication/jsonrequired

Example Bundle create requests

regionstringrequired

Region to create resources in.

(Allowed values for staging environment: EU or US).

Enum"BR""EU""US"
Example: "US"
namestring<= 255 characters

Name of bundle to create. If a name is not specified in the resource blocks then they will be created with this name.

Example: "Sample bundle"
subprojectBundlesSubprojectInputDto (object) or boolean

Subproject resource block.

If set to true, a subproject will be created under the provided projectId with default name from the root object. Optionally a different name can be specified as well as labels on the project.

If not provided or set to false, a subproject will not be created and instead all resources will be created under the projectId provided in the request.

Example: true
One of:

Subproject resource block.

If set to true, a subproject will be created under the provided projectId with default name from the root object. Optionally a different name can be specified as well as labels on the project.

If not provided or set to false, a subproject will not be created and instead all resources will be created under the projectId provided in the request.

smsAppBundlesSmsAppInputDto (object) or boolean

SMS Application resource block.

If set to true, an SMS Application will be created under the project or subproject specified. Optionally a different name can specified.

If not provided or set to false, an SMS Application will not be created.

Example: true
One of:

SMS Application resource block.

If set to true, an SMS Application will be created under the project or subproject specified. Optionally a different name can specified.

If not provided or set to false, an SMS Application will not be created.

convAppBundlesConversationAppInputDto (object) or boolean

Conversation API Application resource block.

If set to true, a Conversation API Application will be created under the project or subproject specified. All other resources created will be associated with the Conversation Application. Optionally a different name can specified as well as Conversation API webhooks.

If not provided or set to false, a Conversation API Application will not be created.

One of:

Conversation API Application resource block.

If set to true, a Conversation API Application will be created under the project or subproject specified. All other resources created will be associated with the Conversation Application. Optionally a different name can specified as well as Conversation API webhooks.

If not provided or set to false, a Conversation API Application will not be created.

webhooksArray of objects(BundlesWebhookInputDto)[ 1 .. 15 ] itemsunique

Provisioning API .

Optionally provide webhook targets for the Provisioning API.

Field 'target' must have unique values across items.

curl -i -X POST \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/bundles' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Small bundle example",
    "region": "US",
    "subproject": true,
    "smsApp": true,
    "convApp": {
      "webhooks": [
        {
          "target": "https://webhook.site/d614d077-302a-4e0b-a06a-276923f7d8d4",
          "secret": "secret",
          "triggers": [
            "MESSAGE_DELIVERY"
          ]
        }
      ],
      "processingMode": "DISPATCH",
      "retentionPolicy": {
        "retentionPolicyType": "MESSAGE_EXPIRE_POLICY",
        "ttl": 7
      }
    },
    "webhooks": [
      {
        "target": "https://webhook.site/d614d077-302a-4e0b-a06a-276923f7d8d4",
        "secret": "secret",
        "triggers": [
          "BUNDLE_DONE"
        ]
      }
    ]
  }'

Responses

Responds with the bundle created. At time of response the bundle might not be completed. To receive the complete payload register a webhook for the BUNDLE_DONE trigger.

Bodyapplication/json
idstringrequired

Id of bundle created.

projectIdstringrequired

The project or subproject id where resources have been created.

statestringrequired

Current state.

Enum"DONE""FAILED""IN_PROGRESS"
regionstringrequired

Region resources were create in.

Enum"BR""EU""US"
namestring<= 255 characters

Name of bundle created. If a name was not specified in the resource blocks then they were created with this name.

webhookDeliveryStatusesArray of objects(BundlesWebhookDeliveryStatusDto)

List delivery statuses for all BUNDLE_DONE webhooks.

subprojectobject

Subproject created, if requested.

smsAppobject

SMS App created, if requested.

convAppobject

Conversation App created, if requested.

webhooksArray of objects(BundlesWebhookDto)

Webhooks registered, if requested.

Response
application/json

Response if the SMS App is not ready. This is the most likely response.

{
  "id": "62a02dd40000000000000000",
  "projectId": "ea026751-3edf-40a9-ad93-1b382bd60a78",
  "name": "Sample response",
  "region": "US",
  "subproject": {
    "id": "ea026751-3edf-40a9-ad93-1b382bd60a78",
    "name": "Sample response",
    "parentProjectId": "18bbdcc8-117d-42f0-85cc-e30462c49404",
    "status": "PENDING"
  },
  "smsApp": {
    "id": "54e5eb6cae6242c88c132c8da8bb1072",
    "smsServiceId": "d84b09da00fb4b76ff63f2fcea8d46c7",
    "name": "Sample response",
    "status": "PENDING_ADD"
  },
  "convApp": {
    "id": "31c12b1042d14b37ae96df96bb13575b",
    "name": "Sample response",
    "processingMode": "CONVERSATION"
  },
  "webhooks": [
    { … }
  ],
  "state": "IN_PROGRESS"
}

Callbacks

Bundle Done Event
post

Get bundle by projectId and bundleIdGA

Request

Retrieve created bundle and resources created.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

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

bundleIdstringrequired

The unique ID of the bundle.

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

Responses

Responds with the bundle created. At time of response the bundle might not be completed.

Bodyapplication/json
idstringrequired

Id of bundle created.

projectIdstringrequired

The project or subproject id where resources have been created.

statestringrequired

Current state.

Enum"DONE""FAILED""IN_PROGRESS"
regionstringrequired

Region resources were create in.

Enum"BR""EU""US"
namestring<= 255 characters

Name of bundle created. If a name was not specified in the resource blocks then they were created with this name.

webhookDeliveryStatusesArray of objects(BundlesWebhookDeliveryStatusDto)

List delivery statuses for all BUNDLE_DONE webhooks.

subprojectobject

Subproject created, if requested.

smsAppobject

SMS App created, if requested.

convAppobject

Conversation App created, if requested.

webhooksArray of objects(BundlesWebhookDto)

Webhooks registered, if requested.

Response
application/json

Response if the SMS App is not ready. This is the most likely response.

{
  "id": "62a02dd40000000000000000",
  "projectId": "ea026751-3edf-40a9-ad93-1b382bd60a78",
  "name": "Sample response",
  "region": "US",
  "subproject": {
    "id": "ea026751-3edf-40a9-ad93-1b382bd60a78",
    "name": "Sample response",
    "parentProjectId": "18bbdcc8-117d-42f0-85cc-e30462c49404",
    "status": "PENDING"
  },
  "smsApp": {
    "id": "54e5eb6cae6242c88c132c8da8bb1072",
    "smsServiceId": "d84b09da00fb4b76ff63f2fcea8d46c7",
    "name": "Sample response",
    "status": "PENDING_ADD"
  },
  "convApp": {
    "id": "31c12b1042d14b37ae96df96bb13575b",
    "name": "Sample response",
    "processingMode": "CONVERSATION"
  },
  "webhooks": [
    { … }
  ],
  "state": "IN_PROGRESS"
}

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

RCS Upscales

The RCS upscales endpoint offers a way for you to manage your RCS upscales.

Operations