# TelstraMessaging.MessagingApi All URIs are relative to *https://tapi.telstra.com/v2* Method | HTTP request | Description ------------- | ------------- | ------------- [**getMMSStatus**](MessagingApi.md#getMMSStatus) | **GET** /messages/mms/{messageid}/status | Get MMS Status [**getSMSStatus**](MessagingApi.md#getSMSStatus) | **GET** /messages/sms/{messageId}/status | Get SMS Status [**retrieveMMSResponses**](MessagingApi.md#retrieveMMSResponses) | **GET** /messages/mms | Retrieve MMS Responses [**retrieveSMSResponses**](MessagingApi.md#retrieveSMSResponses) | **GET** /messages/sms | Retrieve SMS Responses [**sendMMS**](MessagingApi.md#sendMMS) | **POST** /messages/mms | Send MMS [**sendSMS**](MessagingApi.md#sendSMS) | **POST** /messages/sms | Send SMS # **getMMSStatus** > [OutboundPollResponse] getMMSStatus(messageid) Get MMS Status Get MMS Status ### Example ```javascript var TelstraMessaging = require('Telstra_Messaging'); var defaultClient = TelstraMessaging.ApiClient.instance; // Configure OAuth2 access token for authorization: auth var auth = defaultClient.authentications['auth']; auth.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new TelstraMessaging.MessagingApi(); var messageid = "messageid_example"; // String | Unique identifier of a message - it is the value returned from a previous POST call to https://api.telstra.com/v2/messages/mms var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getMMSStatus(messageid, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **messageid** | **String**| Unique identifier of a message - it is the value returned from a previous POST call to https://api.telstra.com/v2/messages/mms | ### Return type [**[OutboundPollResponse]**](OutboundPollResponse.md) ### Authorization [auth](../README.md#auth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getSMSStatus** > [OutboundPollResponse] getSMSStatus(messageId) Get SMS Status If no notification URL has been specified, it is possible to poll for the message status. Note that the `MessageId` that appears in the URL must be URL encoded. Just copying the `MessageId` as it was supplied when submitting the message may not work. SMS Status with Notification URL --- When a message has reached its final state, the API will send a POST to the URL that has been previously specified. <pre><code class=\"language-sh\">{ to: '+61418123456' sentTimestamp: '2017-03-17T10:05:22+10:00' receivedTimestamp: '2017-03-17T10:05:23+10:00' messageId: /cccb284200035236000000000ee9d074019e0301/1261418123456 deliveryStatus: DELIVRD } </code></pre> The fields are: <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>to</code></td> <td>The number the message was sent to.</td> </tr> <tr> <td><code>receivedTimestamp</code></td> <td>Time the message was sent to the API.</td> </tr> <tr> <td><code>sentTimestamp</code></td> <td>Time handling of the message ended.</td> </tr> <tr> <td><code>deliveryStatus</code></td> <td>The final state of the message.</td> </tr> <tr> <td><code>messageId</code></td> <td>The same reference that was returned when the original message was sent.</td> </tr> <tr> <td><code>receivedTimestamp</code></td> <td>Time the message was sent to the API.</td> </tr> </tbody> </table> Upon receiving this call it is expected that your servers will give a 204 (No Content) response. Anything else will cause the API to reattempt the call 5 minutes later. ### Example ```javascript var TelstraMessaging = require('Telstra_Messaging'); var defaultClient = TelstraMessaging.ApiClient.instance; // Configure OAuth2 access token for authorization: auth var auth = defaultClient.authentications['auth']; auth.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new TelstraMessaging.MessagingApi(); var messageId = "messageId_example"; // String | Unique identifier of a message - it is the value returned from a previous POST call to https://api.telstra.com/v2/messages/sms. var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getSMSStatus(messageId, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **messageId** | **String**| Unique identifier of a message - it is the value returned from a previous POST call to https://api.telstra.com/v2/messages/sms. | ### Return type [**[OutboundPollResponse]**](OutboundPollResponse.md) ### Authorization [auth](../README.md#auth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **retrieveMMSResponses** > [MMSContent] retrieveMMSResponses() Retrieve MMS Responses Messages are retrieved one at a time, starting with the earliest response. If the subscription has a `notifyURL`, response messages will be logged there instead. # Notification URL Format for MMS Replies <pre><code class=\"language-sh\">{ \"status\": \"RECEIVED\", \"destinationAddress\": \"+61418123456\", \"senderAddress\": \"+61421987654\", \"subject\": \"Foo\", \"sentTimestamp\": \"2018-03-23T12:15:45+10:00\", \"envelope\": \"string\", \"MMSContent\": [ { \"type\": \"text/plain\", \"filename\": \"text_1.txt\", \"payload\": \"string\" }, { \"type\": \"image/jpeg\", \"filename\": \"sample.jpeg\", \"payload\": \"string\" } ] }</code></pre> The fields are: | Field | Description | | --- | --- | | `status` | The final state of the message. | | `destinationAddress` |The number the message was sent to. | | `senderAddress` | The number the message was sent from. | | `subject` | The subject assigned to the message. | | `sentTimestamp` | Time handling of the message ended. | | `envelope` | Information about about terminal type and originating operator. | | `MMSContent` | An array of the actual content of the reply message. | | `type` | The content type of the message. | | `filename` | The filename for the message content. | | `payload` | The content of the message. | ### Example ```javascript var TelstraMessaging = require('Telstra_Messaging'); var defaultClient = TelstraMessaging.ApiClient.instance; // Configure OAuth2 access token for authorization: auth var auth = defaultClient.authentications['auth']; auth.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new TelstraMessaging.MessagingApi(); var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.retrieveMMSResponses(callback); ``` ### Parameters This endpoint does not need any parameter. ### Return type [**[MMSContent]**](MMSContent.md) ### Authorization [auth](../README.md#auth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **retrieveSMSResponses** > InboundPollResponse retrieveSMSResponses() Retrieve SMS Responses Messages are retrieved one at a time, starting with the earliest response. The API supports the encoding of the full range of emojis in the reply message. The emojis will be in their UTF-8 format. If the subscription has a `notifyURL`, response messages will be logged there instead. # Notification URL Format for SMS Response <pre><code class=\"language-sh\">{ \"to\":\"+61472880123\", \"from\":\"+61412345678\", \"body\":\"Foo4\", \"sentTimestamp\":\"2018-04-20T14:24:35\", \"messageId\":\"DMASApiA0000000146\" }</code></pre> The fields are: | Field | Description | | --- |--- | | `to` | The number the message was sent to. | | `from` | The number the message was sent from. | | `body` | The content of the SMS response. | | `sentTimestamp` | Time handling of the message ended. | | `messageId` | The ID assigned to the message. | ### Example ```javascript var TelstraMessaging = require('Telstra_Messaging'); var defaultClient = TelstraMessaging.ApiClient.instance; // Configure OAuth2 access token for authorization: auth var auth = defaultClient.authentications['auth']; auth.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new TelstraMessaging.MessagingApi(); var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.retrieveSMSResponses(callback); ``` ### Parameters This endpoint does not need any parameter. ### Return type [**InboundPollResponse**](InboundPollResponse.md) ### Authorization [auth](../README.md#auth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **sendMMS** > MessageSentResponse sendMMS(sendMmsRequest) Send MMS Send MMS ### Example ```javascript var TelstraMessaging = require('Telstra_Messaging'); var defaultClient = TelstraMessaging.ApiClient.instance; // Configure OAuth2 access token for authorization: auth var auth = defaultClient.authentications['auth']; auth.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new TelstraMessaging.MessagingApi(); var sendMmsRequest = new TelstraMessaging.SendMmsRequest(); // SendMmsRequest | A JSON or XML payload containing the recipient's phone number and MMS message. The recipient number should be in the format '04xxxxxxxx' where x is a digit. var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.sendMMS(sendMmsRequest, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **sendMmsRequest** | [**SendMmsRequest**](SendMmsRequest.md)| A JSON or XML payload containing the recipient's phone number and MMS message. The recipient number should be in the format '04xxxxxxxx' where x is a digit. | ### Return type [**MessageSentResponse**](MessageSentResponse.md) ### Authorization [auth](../README.md#auth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **sendSMS** > MessageSentResponse sendSMS(sendSMSRequest) Send SMS Send an SMS Message to a single or multiple mobile number/s. ### Example ```javascript var TelstraMessaging = require('Telstra_Messaging'); var defaultClient = TelstraMessaging.ApiClient.instance; // Configure OAuth2 access token for authorization: auth var auth = defaultClient.authentications['auth']; auth.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new TelstraMessaging.MessagingApi(); var sendSMSRequest = new TelstraMessaging.SendSMSRequest(); // SendSMSRequest | A JSON or XML payload containing the recipient's phone number and text message. This number can be in international format if preceeded by a '+' or in national format ('04xxxxxxxx') where x is a digit. var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.sendSMS(sendSMSRequest, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **sendSMSRequest** | [**SendSMSRequest**](SendSMSRequest.md)| A JSON or XML payload containing the recipient's phone number and text message. This number can be in international format if preceeded by a '+' or in national format ('04xxxxxxxx') where x is a digit. | ### Return type [**MessageSentResponse**](MessageSentResponse.md) ### Authorization [auth](../README.md#auth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json