Skip to content
Provisioning API/API Reference/
/
List all senders in proje...

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

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

List all senders in projectGA

Request

Returns a paginated list of senders for the specified project. If no page token is supplied then the first 50 will be returned.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

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

Query
pageTokenstring

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

pageSizenumber[ 1 .. 100 ]

The page size requested.

filterStatesArray of strings(KakaotalkSenderStatesEnum)

Optionally query for sender by states.

Items Enum"ACTIVE""BLOCKED""INACTIVE""SUSPENDED""VERIFYING"
filterStatusesArray of strings(KakaotalkSenderStatusesEnum)

Optionally query for sender by statuses.

Items Enum"DRAFT""IN_PROGRESS""REJECTED"
curl -i -X GET \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/kakaotalk/senders?pageToken=string&pageSize=1&filterStates=ACTIVE&filterStatuses=DRAFT' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of senders

Bodyapplication/json
totalSizenumberrequired

Total size of the entries matching the search query.

pageSizenumberrequired

Requested size of the page.

sendersArray of objects(KakaotalkSenderDto)required

List of senders.

senders[].​plusFriendIdstringrequired

PlusFriend ID

senders[].​idstring

The unique ID of the sender.

senders[].​statestring

The current state of the sender.

Enum"ACTIVE""BLOCKED""INACTIVE""SUSPENDED""VERIFYING"
senders[].​changesobject

Any pending changes to the sender.

senders[].​detailsobject

Sender details and information.

senders[].​createdstring

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

senders[].​modifiedstring

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

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 with senders.

{
  "totalSize": 2,
  "pageSize": 50,
  "senders": [
    { … },
    { … }
  ]
}

Create sender for projectGA

Request

Creates 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.

Bodyapplication/jsonrequired

Sender data

plusFriendIdstring[ 1 .. 30 ] charactersrequired

PlusFriend ID

detailsobjectrequired

Sender details and information. Not required for draft.

details.​adminPhoneNostring(phone number)[ 1 .. 15 ] charactersrequired

Admin phone Not required for draft.

details.​namestring[ 1 .. 512 ] charactersrequired

Sender name Not required for draft.

details.​topLevelCategoryCodestringrequired

Top level category code, must consist of 3 digits (e.g. 001). Not required for draft.

details.​midLevelCategoryCodestringrequired

Mid level category code, must consist of 4 digits (e.g. 0001). Not required for draft.

details.​subLevelCategoryCodestringrequired

Sub level category code, must consist of 4 digits (e.g. 0001). Not required for draft.

details.​logoImagestring(url)

Sender logo

  • Supported mime types: image/jpeg or image/png.
  • Maximum file size: 5MB.
statusstring

Create as draft or submit. Defaults to submit.

Default "SUBMIT"
Enum"DRAFT""SUBMIT"
saveDraftOnFailureboolean

Flag to save template as draft if submission fails. Defaults to false.

Default false
curl -i -X POST \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/kakaotalk/senders' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "plusFriendId": "plusFriendId",
    "status": "SUBMIT",
    "saveDraftOnFailure": true,
    "details": {
      "adminPhoneNo": "+48777777777",
      "name": "Test Name",
      "logoImage": "https://example-logo-image.com",
      "topLevelCategoryCode": "019",
      "midLevelCategoryCode": "0006",
      "subLevelCategoryCode": "0001"
    }
  }'

Responses

Sender

Bodyapplication/json
plusFriendIdstringrequired

PlusFriend ID

idstring

The unique ID of the sender.

statestring

The current state of the sender.

Enum"ACTIVE""BLOCKED""INACTIVE""SUSPENDED""VERIFYING"
changesobject

Any pending changes to the sender.

detailsobject

Sender details and information.

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.

Response
application/json

Response when successfully creating a sender.

{
  "id": "cf11794a-6a5e-4a12-b103-da79bd378bf1",
  "plusFriendId": "5WY5zKfY3pB56EmDVUPQ",
  "changes": {
    "status": "REJECTED",
    "details": { … }
  },
  "created": "2023-02-23T11:28:51.194Z",
  "modified": "2023-02-23T11:28:51.194Z"
}

Callbacks

Sender state active
post
Sender inactive
post
Sender rejected
post
Comment on sender
post

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.

plusFriendIdstringrequired

The unique ID of the sender.

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

Responses

Sender

Bodyapplication/json
plusFriendIdstringrequired

PlusFriend ID

idstring

The unique ID of the sender.

statestring

The current state of the sender.

Enum"ACTIVE""BLOCKED""INACTIVE""SUSPENDED""VERIFYING"
changesobject

Any pending changes to the sender.

detailsobject

Sender details and information.

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.

Response
application/json

Response with a sender.

{
  "id": "cf11794a-6a5e-4a12-b103-da79bd378bf1",
  "plusFriendId": "5WY5zKfY3pB56EmDVUPQ",
  "state": "ACTIVE",
  "details": {
    "adminPhoneNo": "+48777777777",
    "name": "Test Name",
    "logoImage": "https://example-logo-image.com",
    "topLevelCategoryCode": "019",
    "midLevelCategoryCode": "0006",
    "subLevelCategoryCode": "0001"
  },
  "created": "2023-02-23T11:28:51.194Z",
  "modified": "2023-02-23T11:28:51.194Z"
}

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