sinch.domains.conversation.api.v1.capability_apis module

class sinch.domains.conversation.api.v1.capability_apis.Capability(sinch)[source]

Bases: BaseConversation

lookup(
app_id: str,
contact_id: str | None = None,
recipient_identities: List[ChannelRecipientIdentityDict] | None = None,
request_id: str | None | Unset = <sinch.core.sentinel.Unset object>,
**kwargs,
) → LookupCapabilityResponse[source]

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

Parameters:

  • app_id (str) – (required) The ID of the app to use for capability lookup.

  • contact_id (Optional[str]) – The ID of the recipient contact. Either contact_id or recipient_identities must be provided.

  • recipient_identities (Optional[List[ChannelRecipientIdentityDict]]) – Channel identities of the recipient. Either contact_id or recipient_identities must be provided.

  • request_id (UnsetOr[Optional[str]]) – (optional) ID for the asynchronous response, will be generated if not set. Currently this field is not used for idempotency.

  • **kwargs –

    Additional parameters for the request.

Returns:

The registered capability lookup.

Return type:

LookupCapabilityResponse

For detailed documentation, visit https://developers.sinch.com/docs/conversation/.