Capability

A capability query checks the options available for reaching the contact on the channels on which it has a channel identity.

Capability queries can only be executed for contacts that already exist in a project and app. For executing the request, either the contact ID or the channel recipient identities of the contact are required.

The request is executed asynchronously, therefore the service responds immediately. The result of the capability query is sent to the registered webhook for the CAPABILITY trigger.

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.

SecurityBasic or oAuth2

Request

path Parameters

project_id

required

string

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

Request Body schema: application/json
required

The query capability request.

app_id required	string The ID of the app to use for capability lookup.
required	contact_id (object) or identified_by (object) The recipient to lookup capabilities for. Requires either `contact_id` or `identified_by`.
request_id	string ID for the asynchronous response, will be generated if not set. Currently this field is not used for idempotency.

Responses

200

A successful response.

Response Schema: application/json

app_id	string The ID of the app to use for capability lookup.
	contact_id (object) or identified_by (object) The recipient to lookup capabilities for. Requires either `contact_id` or `identified_by`.
request_id	string ID for the asynchronous response, will be generated if not set.

400

Malformed request

401

Incorrect credentials

403

Correct credentials but you don't have access to the requested resource

500

Correct credentials but you don't have access to the requested resource

501

Something went wrong on our end, try again with exponential back-off

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

Request samples

application/json

{"app_id": "{APP_ID}",
"recipient": {"contact_id": "{CONTACT_ID}"
}
}

Response samples