4.1.2. Depending on the type of Resource, the API Client MAY invoke the supported methods (e.g. POST, GET, PUT, DELETE) to achieve an action or a set of actions.

4.1.3. The following are the publicly available Resources that are used for interchange between the MGW and the user’s system:

4.1.3.1. Document Resource

4.1.3.2. DeliveryReceipt Resource

application/vnd.net.wyrls.Document-v3+json

4.3.2. Serialization formats supported:

json = Javascript Object Notation

4.4 Example Document Representation

4.4.1 Sample MO Document (inbound document, as sent from mobile to VirtualShortCode 100234):

{
“message_id”: “61LYH8UZX98OOY11BKERQ2J6XZY2IDT0”,
“from”: “639191234444”,
“to”: “100234”,
“content_type”: “text/plain”,
“body”: “hello world”,
“usagetype”: “MYSERVICE_INBOUND”,
“thread”: “120123182418”,
“telco”: “smart”,
“date”: “20120123T102537”
}

4.4.2. Sample MT Document (outbound document, as sent by API Client from AccessNumber 100234 to mobile)

{
“message_id”: “61LYH8UZX98OOY11BKERQ2J6XZY2IDT0”,
“from”: “100234”,
“to”: “639191234444”,
“content_type”: “text/plain”,
“body”: “Sorry, you sent an invalid keyword. Text HELP to 100234”,
“usagetype”: “MYSERVICE_REPLY_PREMIUM”,
“thread”: “120123182418”,
“date”: “2012-01-23T18:25:43+0800”,
“delivery_receipt_url”: “http://12.34.56.78/uri/to/delivery_receipt_handler”
}

POST ​ /documents ​ HTTP/1.1
Host: ​ <hostname>
Authorization: Basic <base64_encoded_account>

Date: Thu, 2 Feb 2012 22:38:34 GMT
Content-Type: ​ application/vnd.net.wyrls.Document-v3+json
Content-Length: Nnnn
<MT_Document_resource_encoded_as_json>

4.5.3 Successful Response

4.5.3.1. The HTTP status code ​ 202 Accepted​ means that the document was successfully created and enqueued for delivery.

4.5.4 Error Response

4.5.4.1. Error status codes MAY​ include X-Client-Erro​ r header for diagnostics purposes.

4.6.2. Request

4.6.2.1. The MGW user-agent will issue an HTTP POST request with the following:

POST ​ <URL_endpoint_uri_path> ​ HTTP/1.1
Host: ​ <hostname>
Authorization: Basic <base64_encoded_account>
Date: Thu, 2 Feb 2012 22:38:34 GMT
Content-Type: ​ application/vnd.net.wyrls.Document-v3+json
Content-Length: Nnnn
<MO_Document_resource_encoded_as_json>

4.6.3. Successful Response

4.6.3.1. The HTTP status code 202 Accepted means that the document was successfully created and enqueued for delivery.

4.6.3.2. The MGW user-agent MAY also accept any 2xx code

4.6.4. Error Response

4.7.2. Delivery Receipt Representation

4.7.2.1. Every delivery receipt is identified by the content type:

 application/vnd.net.wyrls.DeliveryReceipt-v2+json

4.7.2.2. Serialization format is :

json = Javascript Object Notification

4.7.3. Example DeliveryReceipt Representation

{
“id”: “61LYH8UZX98OOY11BKERQ2J6XZY2IDT0”
“message_id”: “61LYH8UZX98OOY11BKERQ2J6XZY2IDT0”,
“delivered”: true,
“reason_code”: 200,
“reason_description”: “OK”
}

4.8.1. Requirements

4.8.1.1. The User MUST setup the ​ URL endpoint​ where DeliveryReceipts will be sent (HTTP POST).

4.8.1.2. This URL is set per MT document ​ (see the Document Resource field delivery_receipt_url ​ ).

4.8.2. Request

4.8.2.1. The MGW user-agent will issue an HTTP POST request with the following:

POST ​ <URL_endpoint_uri_path> ​ HTTP/1.1
Host: ​ <hostname>
Authorization: Basic <base64_encoded_account>
Date: Thu, 2 Feb 2012 22:38:34 GMT
Content-Type: ​ application/vnd.net.wyrls.Document-v2+json
Content-Length: Nnnn
<MO_Document_resource_encoded_as_json>

4.8.3. Successful Response

4.8.3.1. The HTTP status code ​ 202 Accepted​ should means that the delivery_receipt was successfully created and enqueued for processing.

4.8.3.2. The MGW user-agent MAY also accept any 2xx code.

4.8.4. Error Response