subaccount string | Filters for
|
message_direction string | Filters the results by message direction. Allowed values: |
message_time | Filters outbound and inbound messages based on the time the message was initiated or received. Timestamps are expected to be in YYYY-MM-DD HH:MM[:ss[.uuuuuu]] format, and are considered to be in UTC time zone. If you do not specify this attribute, the MDR for the last 24 hours will be retrived by default. The filter can be used in five forms:
|
message_state string | Filter results by the current status of a message. Allowed values: |
message_type string | Filter results by the type of message. Allowed values: |
error_code string | Filter results by a standard Plivo error code. |
powerpack_id string | Filter results based on messages sent using a specific Power pack. |
from_number string | Filters results by the number or sender ID from which the messages were sent using Plivo APIs. You can filter the details by using the exact number in E.164 format — for example, +12025551212 — or the exact sender ID. |
to_number string | Filters results by the number to which messages were sent using Plivo APIs. You can filter the details by using the exact number in E.164 format — for example, +12025553434. |
limit integer | Denotes the number of results per page. The maximum number of results that can be fetched is 20. Defaults to 20. |
offset integer | Denotes the number of value items by which the results should be offset. Defaults to 0. Read more about offset-based pagination. |
destination_country_iso2 string | Filters results by the ISO2 code of the country associated with the destination number. |
tendlc_registration_status string | Filters results by the 10DLC registration status of the message. Only relevant for long code messaging in the US. |
tendlc_campaign_id string | Filters results by the 10DLC campaign ID associated with the message. Only relevant for long code messaging in the US. |
conversation_id string | Filters results by the WhatsApp conversation ID. |
conversation_origin string | Filters results by the WhatsApp Conversation Origin (Conversation type). Possible values: |
meta
field with the fields:
limit
: the size of the page returned in the responseoffset
: the offset for the page returned in the responsenext
: the URL that points to the next page of resultsprevious
: the URL that points to the previous page of results