Messagebird APIs SmsMessaging: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
Line 27: | Line 27: | ||
https://rest.messagebird.com/messages | https://rest.messagebird.com/messages | ||
</pre> | </pre> | ||
* FILTERS | |||
Besides listing all messages, the API also provides some filters that can be used as query parameters. | |||
: originator : string : Display messages by the specified originator. | |||
: recipient : string : Display messages for the specified recipient. | |||
: direction : string : Display either mt(sent) or mo(received) messages. | |||
: limit : int : Limit the amount of messages listed. | |||
: offset : int : Skip the first n results. | |||
: searchterm : string : Display messages including the specified searchterm. | |||
: type : string : Display messages of type sms, binary or flash. | |||
: contact_id : int : Display messages by contact_id. See Contacts API for more info. | |||
: status : string : Display messages with status scheduled, sent, buffered, delivered, expired or delivery failed. | |||
: from : datetime : Display messages starting from the specified date in RFC 3339 format(Y-m-d | |||
TH:i:sP). | |||
[[category:messagebird]] | [[category:messagebird]] |
Revision as of 09:52, 5 October 2018
Overview
Meessagebird API 내용 정리
SMS Messaging
MessageBird provides an API to send and receive SMS messages to and from any country across the world.
Messages are identified by a unique random ID. And with this ID you can always check the status of the message through the provided endpoint.
- URI
https://rest.messagebird.com/messages
- AVAILABLE HTTP METHODS
POST /messages GET /messages GET /messages/{messageId} DELETE /messages/{messageID}
List message
To list all messages sent and received with your account, you can do a GET request on the /messages endpoint.
- URI
https://rest.messagebird.com/messages
- FILTERS
Besides listing all messages, the API also provides some filters that can be used as query parameters.
- originator : string : Display messages by the specified originator.
- recipient : string : Display messages for the specified recipient.
- direction : string : Display either mt(sent) or mo(received) messages.
- limit : int : Limit the amount of messages listed.
- offset : int : Skip the first n results.
- searchterm : string : Display messages including the specified searchterm.
- type : string : Display messages of type sms, binary or flash.
- contact_id : int : Display messages by contact_id. See Contacts API for more info.
- status : string : Display messages with status scheduled, sent, buffered, delivered, expired or delivery failed.
- from : datetime : Display messages starting from the specified date in RFC 3339 format(Y-m-d
TH:i:sP).