SIsinch
Capability

Capability lookup

This method is asynchronous - it immediately returns the requested Capability registration. Capability check is then delivered as a callback to registered webhooks with trigger CAPABILITY for every reachable channel.

post/v1/projects/{project_id}/capability:query

Request

  • Base URL
    https://us.conversation.api.sinch.com
  • URL
    https://us.conversation.api.sinch.com/v1/projects/{project_id}/capability:query
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://auth.sinch.com/oauth2/token

Request body

app_idstring required

The ID of the app to use for capability lookup.

request_idstring

ID for the asynchronous response, will be generated if not set. Currently this field is not used for idempotency.

Example request

{
  "app_id": "{APP_ID}",
  "recipient": {
    "identified_by": {
      "channel_identities": [
        {
          "channel": "WHATSAPP"
        }
      ]
    }
  }
}

Response

A successful response.

app_idstring

The ID of the app to use for capability lookup.

request_idstring

ID for the asynchronous response, will be generated if not set.

Example response

{
  "recipient": {
    "identified_by": {
      "channel_identities": [
        {
          "channel": "WHATSAPP"
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.