Messagebird APIs SmsMessaging: Difference between revisions

From 탱이의 잡동사니
Jump to navigation Jump to search
Line 30: Line 30:
* FILTERS
* FILTERS
Besides listing all messages, the API also provides some filters that can be used as query parameters.
Besides listing all messages, the API also provides some filters that can be used as query parameters.
: '''Attribute''' : '''Type''' : '''Description'''
: originator : string : Display  messages by the specified originator.
: originator : string : Display  messages by the specified originator.
: recipient : string : Display messages for the specified recipient.
: recipient : string : Display messages for the specified recipient.
Line 41: Line 42:
: from : datetime : Display messages starting from the specified date in RFC 3339 format(Y-m-d\TH:i:sP).
: from : datetime : Display messages starting from the specified date in RFC 3339 format(Y-m-d\TH:i:sP).
: until : datetime : Display messages until the specified date in RFC 3339 format(Y-m-d\TH:i:sP).
: until : datetime : Display messages until the specified date in RFC 3339 format(Y-m-d\TH:i:sP).
* EXAMPLE
<pre>
curl -X GET https://rest.messagebird.com/messages\?access_key\=test_gshuPaZoeEG6ovbc8M79w0QyM
{"offset":0,"limit":20,"count":0,"totalCount":0,"links":{"first":null,"previous":null,"next":null,"last":null},"items":[]}
</pre>
=== The message object ===
This object represents a message at MessageBird.com
* ATTRIBUTES
: '''Attribute''' : '''Type''' : '''Description'''
: id : string :


[[category:messagebird]]
[[category:messagebird]]

Revision as of 10:07, 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.

Attribute : Type : Description
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).
until : datetime : Display messages until the specified date in RFC 3339 format(Y-m-d\TH:i:sP).
  • EXAMPLE
curl -X GET https://rest.messagebird.com/messages\?access_key\=test_gshuPaZoeEG6ovbc8M79w0QyM

{"offset":0,"limit":20,"count":0,"totalCount":0,"links":{"first":null,"previous":null,"next":null,"last":null},"items":[]}

The message object

This object represents a message at MessageBird.com

  • ATTRIBUTES
Attribute : Type : Description
id : string :
Retrieved from "http://wiki.pchero21.com/index.php?title=Messagebird_APIs_SmsMessaging&oldid=2990"