Messagebird General - Revision history

Pchero at 09:36, 5 October 2018

2018-10-05T09:36:43Z

← Older revision		Revision as of 09:36, 5 October 2018
Line 2:		Line 2:
	Messagebird develop document 내용 정리		Messagebird develop document 내용 정리

	~~== General ==~~		== Introduction ==
	=== Introduction ===
	The MessageBird APIs connect your website or application to operators around the world. With our APIs you can integrate SMS, Chat & Voice.		The MessageBird APIs connect your website or application to operators around the world. With our APIs you can integrate SMS, Chat & Voice.

	==== REST ====		=== REST ===
	The MessageBird API uses HTTP verbs and a RESTful endpoint structure. An access key is used as the API Authoriiztion framework. Request and response payloads are formatted as JSON(although we provide a GET alternative for requests), using UTF-8 encoding and URL encoded values.		The MessageBird API uses HTTP verbs and a RESTful endpoint structure. An access key is used as the API Authoriiztion framework. Request and response payloads are formatted as JSON(although we provide a GET alternative for requests), using UTF-8 encoding and URL encoded values.

	==== GET STARTED ====		=== GET STARTED ===
	To use this API you an account on MessageBird.com and an access key, which can be created in your account.		To use this API you an account on MessageBird.com and an access key, which can be created in your account.

	MessageBird provides the creation of the keys to discover and test the API at your own convenience. The difference between a live key and a test key is that a live key actually sends a message, while a test key does not. However, when you send a message using a test key, you will get a fake created object back.		MessageBird provides the creation of the keys to discover and test the API at your own convenience. The difference between a live key and a test key is that a live key actually sends a message, while a test key does not. However, when you send a message using a test key, you will get a fake created object back.

	==== API ENDPOINT ====		=== API ENDPOINT ===
	<pre>		<pre>
	https://rest.messagebird.com/		https://rest.messagebird.com/
	</pre>		</pre>

	==== IP-ADDRESS ====		=== IP-ADDRESS ===
	Our API platform is offered from a global distributed infrastructure. Hence you will not be able to whitelist the IP-addresses of our platform. Requests from our platform (for delivery reports and inbound messages) originate from various IP-addresses.		Our API platform is offered from a global distributed infrastructure. Hence you will not be able to whitelist the IP-addresses of our platform. Requests from our platform (for delivery reports and inbound messages) originate from various IP-addresses.

	=== Authentication ===		== Authentication ==
	When each API call you will need to set request headers including your access key to authenticate yourself.		When each API call you will need to set request headers including your access key to authenticate yourself.

Line 51:		Line 50:
	If possible, please use the Authorization header.		If possible, please use the Authorization header.

	=== Requests ===		== Requests ==
	POST and PUT requests to the API should contain a JSON-formatted payload in the request body. Alternatively, resource attributes can be sent through GET parameters(See alternatives).		POST and PUT requests to the API should contain a JSON-formatted payload in the request body. Alternatively, resource attributes can be sent through GET parameters(See alternatives).

Line 63:		Line 62:
	</pre>		</pre>

	=== Errors ===		== Errors ==
	MessageBird uses standard HTTP status codes to indicate success or failure of an API request. Codes in the 2xx range indicate that a request was successfully processed and codes in the 4xx range indicate that there was an error that resulted from the information sent(e.g. authentication, no balance or a missing or wrong parameter).		MessageBird uses standard HTTP status codes to indicate success or failure of an API request. Codes in the 2xx range indicate that a request was successfully processed and codes in the 4xx range indicate that there was an error that resulted from the information sent(e.g. authentication, no balance or a missing or wrong parameter).

Pchero: /* HTTP Methods */

2018-10-05T09:35:38Z

HTTP Methods

← Older revision		Revision as of 09:35, 5 October 2018
Line 114:		Line 114:
	</pre>		</pre>

	=== HTTP Methods ===		== HTTP Methods ==
	The MessageBird API uses HTTP verbs to understand if you want to read(GET), delete(DELETE) or create(POST) an object. When your website or application doesn't have the possibility to do a POST or DELETE, we provide the ability to set the method through the query parameter _method.		The MessageBird API uses HTTP verbs to understand if you want to read(GET), delete(DELETE) or create(POST) an object. When your website or application doesn't have the possibility to do a POST or DELETE, we provide the ability to set the method through the query parameter _method.

Line 129:		Line 129:
	</pre>		</pre>

	[[category:~~telephony~~]]		[[category:messagebird]]

Pchero: Pchero moved page Messagebird to Messagebird General without leaving a redirect

2018-10-05T09:35:16Z

Pchero moved page Messagebird to Messagebird General without leaving a redirect

← Older revision	Revision as of 09:35, 5 October 2018
(No difference)

Pchero at 09:31, 5 October 2018

2018-10-05T09:31:34Z

← Older revision		Revision as of 09:31, 5 October 2018
Line 51:		Line 51:
	If possible, please use the Authorization header.		If possible, please use the Authorization header.

	== Requests ==		=== Requests ===
	POST and PUT requests to the API should contain a JSON-formatted payload in the request body. Alternatively, resource attributes can be sent through GET parameters(See alternatives).		POST and PUT requests to the API should contain a JSON-formatted payload in the request body. Alternatively, resource attributes can be sent through GET parameters(See alternatives).

Line 63:		Line 63:
	</pre>		</pre>

	== Errors ==		=== Errors ===
	MessageBird uses standard HTTP status codes to indicate success or failure of an API request. Codes in the 2xx range indicate that a request was successfully processed and codes in the 4xx range indicate that there was an error that resulted from the information sent(e.g. authentication, no balance or a missing or wrong parameter).		MessageBird uses standard HTTP status codes to indicate success or failure of an API request. Codes in the 2xx range indicate that a request was successfully processed and codes in the 4xx range indicate that there was an error that resulted from the information sent(e.g. authentication, no balance or a missing or wrong parameter).

Line 112:		Line 112:

	{"errors":[{"code":9,"description":"body is required","parameter":"body"}]}		{"errors":[{"code":9,"description":"body is required","parameter":"body"}]}
			</pre>

			=== HTTP Methods ===
			The MessageBird API uses HTTP verbs to understand if you want to read(GET), delete(DELETE) or create(POST) an object. When your website or application doesn't have the possibility to do a POST or DELETE, we provide the ability to set the method through the query parameter _method.

			Alternatively, resource attributes can be sent through GET attributes instead of a JSON body.

			* SENDING A MESSAGE
			<pre>
			/messages?_method=POST&msisdn=31612345678&...
			</pre>

			* REQUESTING AN HLR
			<pre>
			/hlr?_method=POST&msisdn=31612345678&...
	</pre>		</pre>

	[[category:telephony]]		[[category:telephony]]

Pchero: /* Requests */

2018-10-05T09:26:57Z

Requests

@@ Line 61: / Line 61: @@
      "body":"The message to be sent"
+}
 </pre>
 [[category:telephony]]

Pchero: /* General */

2018-10-05T08:58:49Z

General

← Older revision		Revision as of 08:58, 5 October 2018
Line 50:		Line 50:

	If possible, please use the Authorization header.		If possible, please use the Authorization header.

			== Requests ==
			POST and PUT requests to the API should contain a JSON-formatted payload in the request body. Alternatively, resource attributes can be sent through GET parameters(See alternatives).

			* JSON REQUEST PAYLOAD EXAMPLE
			<pre>
			{
			"recipients":31612345678,
			"originator":"MessageBird",
			"body":"The message to be sent"
			}
			</pre>

	[[category:telephony]]		[[category:telephony]]

Pchero: /* Authentication */

2018-10-05T08:55:56Z

Authentication

← Older revision		Revision as of 08:55, 5 October 2018
Line 36:		Line 36:

	* CURL EXAMPLE		* CURL EXAMPLE
	<~~source lang=bash~~>		<pre>
	$ curl https://rest.messagebird.com/balance -H 'Authorization: AccessKey test_gshuPaZoeEG6ovbc8M79w0QyM'		$ curl https://rest.messagebird.com/balance -H 'Authorization: AccessKey test_gshuPaZoeEG6ovbc8M79w0QyM'

	{"payment":"prepaid","type":"credits","amount":10.1}		{"payment":"prepaid","type":"credits","amount":10.1}
	</~~source~~>		</pre>

	* EXAMPLE(GET)		* EXAMPLE(GET)
	<~~source lang=bash~~>		<pre>
	$ curl https://rest.messagebird.com/balance\?access_key\=test_gshuPaZoeEG6ovbc8M79w0QyM		$ curl https://rest.messagebird.com/balance\?access_key\=test_gshuPaZoeEG6ovbc8M79w0QyM

	{"payment":"prepaid","type":"credits","amount":10.1}		{"payment":"prepaid","type":"credits","amount":10.1}
	</~~source~~>		</pre>

	If possible, please use the Authorization header.		If possible, please use the Authorization header.

	[[category:telephony]]		[[category:telephony]]

Pchero: /* General */

2018-10-05T08:55:23Z

General

← Older revision		Revision as of 08:55, 5 October 2018
Line 6:		Line 6:
	The MessageBird APIs connect your website or application to operators around the world. With our APIs you can integrate SMS, Chat & Voice.		The MessageBird APIs connect your website or application to operators around the world. With our APIs you can integrate SMS, Chat & Voice.

	==== REST =====		==== REST ====
	The MessageBird API uses HTTP verbs and a RESTful endpoint structure. An access key is used as the API Authoriiztion framework. Request and response payloads are formatted as JSON(although we provide a GET alternative for requests), using UTF-8 encoding and URL encoded values.		The MessageBird API uses HTTP verbs and a RESTful endpoint structure. An access key is used as the API Authoriiztion framework. Request and response payloads are formatted as JSON(although we provide a GET alternative for requests), using UTF-8 encoding and URL encoded values.

Pchero: Created page with "== Overview == Messagebird develop document 내용 정리 == General == === Introduction === The MessageBird APIs connect your website or application to operators around the..."

2018-10-05T08:55:08Z

Created page with "== Overview == Messagebird develop document 내용 정리 == General == === Introduction === The MessageBird APIs connect your website or application to operators around the..."

New page

== Overview ==
Messagebird develop document 내용 정리

== General ==
=== Introduction ===
The MessageBird APIs connect your website or application to operators around the world. With our APIs you can integrate SMS, Chat & Voice.

==== REST =====
The MessageBird API uses HTTP verbs and a RESTful endpoint structure. An access key is used as the API Authoriiztion framework. Request and response payloads are formatted as JSON(although we provide a GET alternative for requests), using UTF-8 encoding and URL encoded values.

==== GET STARTED ====
To use this API you an account on MessageBird.com and an access key, which can be created in your account.

MessageBird provides the creation of the keys to discover and test the API at your own convenience. The difference between a live key and a test key is that a live key actually sends a message, while a test key does not. However, when you send a message using a test key, you will get a fake created object back.

==== API ENDPOINT ====
<pre>
https://rest.messagebird.com/
</pre>

==== IP-ADDRESS ====
Our API platform is offered from a global distributed infrastructure. Hence you will not be able to whitelist the IP-addresses of our platform. Requests from our platform (for delivery reports and inbound messages) originate from various IP-addresses.

=== Authentication ===
When each API call you will need to set request headers including your access key to authenticate yourself.

Don't have an access key? Get an access key in the API menu in your account. There you can create test and live keys.

When your application can't send an Authorization header, you can use the GET parameter access_key to provide your access key.

We do not provide incoming request whitelisting on our platform for our REST API. All requests are forced SSL with an access key.

* PARAMETER
: Authorization : When calling our API, send your access key with the authentication type set as AccessKey(Example: Authorization: AccessKey {accessKey}). Required.
: Accept : Set to application/json. Required.

* CURL EXAMPLE
<source lang=bash>
$ curl https://rest.messagebird.com/balance -H 'Authorization: AccessKey test_gshuPaZoeEG6ovbc8M79w0QyM'

{"payment":"prepaid","type":"credits","amount":10.1}
</source>

* EXAMPLE(GET)
<source lang=bash>
$ curl https://rest.messagebird.com/balance\?access_key\=test_gshuPaZoeEG6ovbc8M79w0QyM

{"payment":"prepaid","type":"credits","amount":10.1}
</source>

If possible, please use the Authorization header.

[[category:telephony]]