sinch.domains.sms.api.v1.inbounds_apis module
- class sinch.domains.sms.api.v1.inbounds_apis.Inbounds(sinch)[source]
Bases:
BaseSms- get(
- inbound_id: str,
- **kwargs,
This operation retrieves a specific inbound message using the provided inbound ID.
- Parameters:
inbound_id (str) – The inbound ID found when listing inbound messages. (required)
**kwargs –
Additional parameters for the request.
- Returns:
InboundMessage
- Return type:
For detailed documentation, visit https://developers.sinch.com/docs/sms/.
- list(
- page: int | None = None,
- page_size: int | None = None,
- to: List[str] | None = None,
- start_date: datetime | None = None,
- end_date: datetime | None = None,
- client_reference: str | None = None,
- **kwargs,
- With the list operation,
you can list all inbound messages that you have received. This operation supports pagination. Inbounds are returned in reverse chronological order.
- Parameters:
page (Optional[int]) – The page number starting from 0. (optional)
page_size (Optional[int]) – Determines the size of a page (optional)
to (Optional[List[str]]) – Only list messages sent to this destination. Multiple phone numbers formatted as either [E.164](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) or short codes can be comma separated. (optional)
start_date – Only list messages received at or after this date/time. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): YYYY-MM-DDThh:mm:ss.SSSZ. Default: Now-24 (optional)
client_reference (Optional[str]) – Using a client reference in inbound messages requires additional setup on your account. Contact your [account manager](https://dashboard.sinch.com/settings/account-details) to enable this feature. Only list inbound messages that are in response to messages with a previously provided client reference. (optional)
**kwargs –
Additional parameters for the request.
end_date (Optional[datetime])
- Returns:
Paginator[InboundMessage]
- Return type:
For detailed documentation, visit https://developers.sinch.com/docs/sms/.