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.
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.
| project_id required | string The unique ID of the project. You can find this on the Sinch Dashboard. |
The query capability request.
A successful response.
Malformed request. See common error responses for more information.
Incorrect credentials. See common error responses for more information.
Correct credentials but you don't have access to the requested resource. See common error responses for more information.
Correct credentials but you don't have access to the requested resource. See common error responses for more information.
Something went wrong on our end, try again with exponential back-off. See common error responses for more information.
{- "app_id": "{APP_ID}",
- "recipient": { }
}{- "app_id": "string",
- "recipient": {
- "contact_id": "{CONTACT_ID}"
}, - "request_id": "string"
}