Skip to content

Latest commit

 

History

History
39 lines (31 loc) · 2.33 KB

File metadata and controls

39 lines (31 loc) · 2.33 KB

Query

search parameters for querying the message database

Properties

Name Type Description Notes
status str The status of the messages you would like returned (either 'SENT', 'DELIVERED', 'EXPIRED', 'UNDELIVERABLE', 'REJECTED' or 'INCOMING') [optional]
credits float The number of credits used on the message. Floating point number. [optional]
destination str The phone number of the recipient. Start UK numbers with 44 and drop the leading 0. [optional]
sender str The sender of the message (this can be the configured sender name for an outbound message or the senders phone number for an inbound message). [optional]
keyword str The keyword used in the inbound message [optional]
var_from str The date-time from which you would like matching messages [optional]
to str The date-time to which you would like matching messages [optional]
limit float The maximum number of messages that you would like returned in this call. The default is 1000. [optional]
skip float The number of results you would like to ignore before returning messages. In combination with the 'limit' parameter his can be used to page results, so that you can deal with a limited number in your logic at each time. [optional]
unread bool In queries for incoming messages ('status' is 'INCOMING'), specify whether you explicitly want unread messages (true) or read messages (false). Omit this parameter in other circumstances. [optional]
metadata QueryMetadata [optional]

Example

from openapi_client.models.query import Query

# TODO update the JSON string below
json = "{}"
# create an instance of Query from a JSON string
query_instance = Query.from_json(json)
# print the JSON string representation of the object
print Query.to_json()

# convert the object into a dict
query_dict = query_instance.to_dict()
# create an instance of Query from a dict
query_form_dict = query.from_dict(query_dict)

[Back to Model list] [Back to API list] [Back to README]