Sinch Provisioning API

Overview

Use this skill for Conversation API channel provisioning. Validated against Provisioning API v1.2.36. Prefer deterministic flows: confirm context, choose endpoint family, execute minimal calls, verify state.

Agent Workflow (Default)

Use this sequence unless the user requests otherwise.

1. Confirm scope and identifiers

• Confirm projectId
• Confirm microservice scope — each is a separate REST service: WhatsApp, RCS, KakaoTalk, Conversation, Webhooks, or Bundles

2. Choose the endpoint family first

• WhatsApp account/senders/templates/flows/solutions: /v1/projects/{projectId}/whatsapp/...
• RCS: /v1/projects/{projectId}/rcs/...
• KakaoTalk: /v1/projects/{projectId}/kakaotalk/...
• Conversation (channel info): /v1/projects/{projectId}/conversation/...
• Webhooks: /v1/projects/{projectId}/webhooks...
• Bundles: /v1/projects/{projectId}/bundles...

3. Apply safe defaults

• Webhook target must be unique per project
• Use ALL for webhook triggers when broad coverage is needed
• WhatsApp template language delete: deleteSubmitted defaults to false

4. Verify async operations

• Some operations are asynchronous — register a provisioning webhook to receive completion notifications
• Webhook payloads contain the full JSON response as payload
• Alternatively, poll status endpoints for state changes
• For bundles, subscribe to BUNDLE_DONE

5. Handle failures predictably

• All endpoints return a PAPI Error (Provisioning API Error) on failure:

  {
    "errorCode": "string (enum)",
    "message": "string (human-readable errorCode)",
    "resolution": "string (what can be changed/improved)",
    "additionalInformation": {} // optional, contains context e.g. senderId
  }

• For 429 and 5xx, retry with bounded backoff (default: max 3 retries, exponential + jitter, max 10s delay)
• For 4xx, use resolution and additionalInformation from the PAPI Error to guide correction

6. Return actionable result

• Include resource IDs, resulting state, and next required action

Getting Started

Agent Credentials handling

Store credentials in environment variables — never hardcode tokens or keys in commands or source code:

export SINCH_PROJECT_ID="your-project-id"
export SINCH_KEY_ID="your-key-id"
export SINCH_KEY_SECRET="your-key-secret"
export SINCH_ACCESS_TOKEN="your-oauth-token"

Authentication

Ensure that authentication headers are properly set when making API calls. The Provisioning API uses Bearer token authentication:

-H "Authorization: Bearer $SINCH_ACCESS_TOKEN"

See sinch-authentication for full setup, most importantly how to obtain {SINCH_ACCESS_TOKEN} (OAuth2 client-credentials — do not mint your own JWT).

Supported auth methods:

• OAuth 2.0 bearer token (recommended)
• HTTP Basic auth

Prefer OAuth 2.0 for automation/CI. Use Basic auth only for quick manual tests.

Canonical curl Example

curl -X GET \
  "https://provisioning.api.sinch.com/v1/projects/$SINCH_PROJECT_ID/whatsapp/senders" \
  -H "Authorization: Bearer $SINCH_ACCESS_TOKEN"

Microservices

All endpoints are under https://provisioning.api.sinch.com/v1/projects/{projectId}/. All return JSON responses. List endpoints are paginated; follow nextPageToken to retrieve all results.

Trigger Strategy (Webhook)

Use ALL unless the user explicitly asks for selective triggers. If ALL is used, do not combine it with other trigger values. For production, prefer selective triggers when broad audit coverage is not required.

When selective filtering is requested, choose by family:

• WhatsApp account: WHATSAPP_ACCOUNT_*, WHATSAPP_WABA_ACCOUNT_CHANGED
• WhatsApp sender/template: WHATSAPP_SENDER_*, WHATSAPP_TEMPLATE_*
• RCS: RCS_ACCOUNT_COMMENT_ADDED, RCS_SENDER_*
• KakaoTalk: KAKAOTALK_SENDER_*, KAKAOTALK_TEMPLATE_*
• Bundles: BUNDLE_DONE

Critical Gotchas

1. Sender OTP flow order is strict (WhatsApp and KakaoTalk)

• Register first, then verify

2. WhatsApp templates are project-level

• Do not route through sender-scoped template paths

3. Template delete behavior

• Language-specific delete defaults to draft-only unless deleteSubmitted=true (query flag)

4. Webhook uniqueness constraint

• Uniqueness is on target URL per project, not on trigger overlap

5. Async completion

• Sender/template/account transitions can be asynchronous; rely on status endpoints or webhooks

6. Deprecated WhatsApp utility endpoints

• longLivedAccessToken and wabaDetails are deprecated. Use only for legacy flows when explicitly requested.

Links

Use these pages instead of adding inline examples.

• Provisioning API Reference
• Webhooks
• WhatsApp Accounts
• WhatsApp Senders
• WhatsApp Templates
• WhatsApp Flows
• WhatsApp Solutions
• RCS Accounts
• RCS Questionnaire
• RCS Senders
• KakaoTalk Categories
• KakaoTalk Senders
• KakaoTalk Templates
• Conversation Channels
• Bundles
• Getting Started with KakaoTalk
• Getting Started with WhatsApp
• Provisioning API OpenAPI YAML
• Release Notes
• LLMs.txt