You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-8Lines changed: 3 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,9 @@
1
1
# Telstra_Messaging
2
2
3
3
TelstraMessaging - JavaScript client for Telstra_Messaging
4
-
The Telstra SMS Messaging API allows your applications to send and receive SMS text messages from Australia's leading network operator. It also allows your application to track the delivery status of both sent and received SMS messages.
5
4
6
-
- API version: 2.2.4
7
-
- Package version: 1.0.2
5
+
- API version: 2.2.6
6
+
- Package version: 1.0.4
8
7
9
8
## Installation
10
9
@@ -118,7 +117,7 @@ All URIs are relative to *https://tapi.telstra.com/v2*
To generate an OAuth2 Authentication token, pass through your `Client key` and `Client secret` that you received when you registered for the &quot;API Free Trial&quot; Product. The grant_type should be left as `client_credentials` and the scope as `NSMS`. The token will expire in one hour. <pre><code class=\"language-sh\"> #!/bin/bash # Obtain these keys from the Telstra Developer Portal CLIENT_KEY=\"your client key\" CLIENT_SECRET=\"your client secret\" curl -X POST -H 'Content-Type: application/x-www-form-urlencoded'\\ -d 'grant_type=client_credentials&amp;client_id=$CLIENT_KEY&amp;client_secret=CLIENT_SECRET&amp;scope=NSMS'\\'https://tapi.telstra.com/v2/oauth/token' </code></pre>
**to** | **String** | Just a copy of the number the message is sent to. |
7
+
**deliveryStatus** | **String** | Gives an indication if the message has been accepted for delivery. The description field contains information on why a message may have been rejected. |
8
+
**messageId** | **String** | For an accepted message, ths will be a unique reference that can be used to check the messages status. Please refer to the Delivery Notification section. Note that `messageId` will be different for each number that the message was sent to. |
9
+
**messageStatusURL** | **String** | For an accepted message, ths will be the URL that can be used to check the messages status. Please refer to the Delivery Notification section. | [optional]
Copy file name to clipboardExpand all lines: docs/MessagingApi.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -68,7 +68,7 @@ Name | Type | Description | Notes
68
68
69
69
Get SMS Status
70
70
71
-
Get Message Status
71
+
If no notification URL has been specified, it is possible to poll for the message status. <pre><code class=\"language-sh\"> #!/bin/bash #!/bin/bash # Example of how to poll for a message status AccessToken=\"Consumer Access Token\" MessageId=\"Previous supplied Message Id, URL encoded\" curl -X get -H \"Authorization: Bearer $AccessToken\" \\ -H \"Content-Type: application/json\" \\\"https://tapi.telstra.com/v2/messages/sms/$MessageId\"</code></pre> 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.
var apiInstance =newTelstraMessaging.MessagingApi();
83
83
84
-
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
84
+
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.
**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 |
101
+
**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. |
102
102
103
103
### Return type
104
104
@@ -119,7 +119,7 @@ Name | Type | Description | Notes
119
119
120
120
Retrieve SMS Responses
121
121
122
-
Retrieve Messages
122
+
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.
123
123
124
124
### Example
125
125
```javascript
@@ -215,7 +215,7 @@ Name | Type | Description | Notes
215
215
216
216
Send SMS
217
217
218
-
Send Message
218
+
Send an SMS Message to a single or multiple mobile number/s. <h3>Send message to a single number: </h3> <pre><code class=\"language-sh\"> #!/bin/bash # Use the Messaging API-v2 to send an SMS # Note: only to: and body: are required AccessToken=\"Access Token\" Dest=\"Destination number\" curl -X POST -H \"Authorization: Bearer $AccessToken\" -H \"Content-Type: application/json\" -d \"{ \\\"to\\\":\\\"$Dest\\\", \\\"body\\\":\\\"Test Message\\\", \\\"from\\\": \\\"+61412345678\\\", \\\"validity\\\": 5, \\\"scheduledDelivery\\\": 1, \\\"notifyURL\\\": \\\"\\\", \\\"replyRequest\\\": false \\\"priority\\\": true }\" \"https://tapi.telstra.com/v2/messages/sms\" </code></pre> \\ <h3>Send message to multiple numbers: </h3> <pre><code class=\"language-sh\"> #!/bin/bash # Use the Messaging API to send an SMS AccessToken=\"Access Token\" Dest=\"Destination number\" curl -X post -H \"Authorization: Bearer $AccessToken\" \\ -H \"Content-Type: application/json\" \\ -d '{ \"to\":\"$dest1, $dest2, $dest3\", \"body\":\"Test Message\" }' \\ https://tapi.telstra.com/v2/messages/sms <pre><code class=\"language-sh\">
var apiInstance =newTelstraMessaging.MessagingApi();
230
230
231
-
var payload =newTelstraMessaging.SendSMSRequest(); // SendSMSRequest | A JSON or XML payload containing the recipient's phone number and text message. The recipient number should be in the format '04xxxxxxxx' where x is a digit
231
+
var payload =newTelstraMessaging.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.
**payload** | [**SendSMSRequest**](SendSMSRequest.md)| A JSON or XML payload containing the recipient's phone number and text message. The recipient number should be in the format '04xxxxxxxx' where x is a digit |
248
+
**payload** | [**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. |
**activeDays** | **Number** | The number of days before for which this number is provisioned. Usually this will be same as the plan you buy. | [optional]
7
+
**notifyURL** | **String** | A callback URL that will be POSTed to whenever a new message arrives at this destination address. If this is not provided then you can make use the Get Replies API to poll for messages. | [optional]
8
+
**callbackData** | **String** | A JSON that will be sent as the body in the POST to the notifyURL. This can be any meaningful data relevant to your application. | [optional]
Invoke the provisioning API to get a dedicated mobile number for an account or application. <pre><code class=\"language-sh\"> #!/bin/bash curl -X POST \\https://tapi.telstra.com/v2/messages/provisioning/subscriptions\\ -H 'authorization: Bearer $ACCESS_TOKEN'\\ -H 'cache-control: no-cache'\\ -H 'content-type: application/json'\\ -d '{ \"activeDays\":30, \"notifyURL\":\"http://example.com/callback\", \"callbackData\": { \"anything\":\"some data\" } }'</code></pre>
Copy file name to clipboardExpand all lines: docs/SendMmsRequest.md
+2-1Lines changed: 2 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
**to** | **String** | This is the destination address. |
8
8
**subject** | **String** | The subject that will be used in an MMS message. |
9
9
**replyRequest** | **Boolean** | If set to true, the reply message functionality will be implemented and the to address will be ignored if present. |
10
-
**mMSContent** | [**[MMSContent]**](MMSContent.md) | An Array of content that will be sent in an MMS message. If this array is present it will cause the “body” element to be ignored, and the message will be sent as an MMS. |
**mMSContent** | [**[MMSContent]**](MMSContent.md) | An Array of content that will be sent in an MMS message. If this array is present it will cause the body element to be ignored, and the message will be sent as an MMS. |
**to** | **String** | Phone number (in E.164 format) to send the SMS to. This number can be in international format if preceeded by a ‘+’, or in national format. |
7
-
**body** | **String** | The text body of the message. Messages longer than 160 characters will be counted as multiple messages. |
8
-
**from** | **String** | Phone number (in E.164 format) the SMS was sent from. If not present, the serverice will use the mobile number associated with the application, or it be an Alphanumeric address of up to 11 characters. | [optional]
9
-
**validity** | **Number** | How long the platform should attempt to deliver the message for. This period is specified in minutes from the message | [optional]
10
-
**scheduledDelivery** | **Number** | How long the platform should wait before attempting to send the message - specified in minutes. | [optional]
11
-
**notifyURL** | **String** | Contains a URL that will be called once your message has been processed. The status may be delivered, expired, deleted, etc. | [optional]
12
-
**replyRequest** | **Boolean** | If set to true, the reply message functionality will be implemented and the to address will be ignored if present. If false or not present, then normal message handling is implemented. | [optional]
6
+
**to** | **String** | Phone number (in E.164 format) to send the SMS to. This number can be in international format `\"to\": \"+61412345678\"` or in national format. Can be an array of strings if sending to multiple numbers: `\"to\": \"+61412345678, +61418765432\"` |
7
+
**body** | **String** | The text body of the message. Messages longer than 160 characters will be counted as multiple messages. This field contains the message text, this can be up to 1900 (for a single recipient) or 500 (for multiple recipients) UTF-8 characters. As mobile devices rarely support the full range of UTF-8 characters, it is possible that some characters may not be translated correctly by the mobile device |
8
+
**from** | **String** | The Alphanumeric sender ID of up to 11 characters or phone number the SMS was sent from. If not present, the service will use the mobile number associated with the application (in E.164 format). This feature is only available on paid plans. | [optional]
9
+
**validity** | **Number** | How long the platform should attempt to deliver the message for. This period is specified in minutes from the message. Normally if the message cannot be delivered immediately, it will be stored and delivery will be periodically reattempted. The network will attempt to send the message for up to seven days. It is possible to define a period smaller than 7 days by including this parameter and specifying the number of minutes that delivery should be attempted. eg: including `\"validity\": 60` will specify that if a message can't be delivered within the first 60 minutes them the network should stop. | [optional]
10
+
**scheduledDelivery** | **Number** | How long the platform should wait before attempting to send the message - specified in minutes. e.g.: If `\"scheduledDelivery\": 120` is included, then the network will not attempt to start message delivery for two hours after the message has been submitted | [optional]
11
+
**notifyURL** | **String** | Contains a URL that will be called once your message has been processed. The status may be delivered, expired, deleted, etc. It is possible for the network to make a call to a URL when the message has been delivered (or has expired), different URLs can be set per message. Please refer to the Delivery Notification section. | [optional]
12
+
**replyRequest** | **Boolean** | If set to true, the reply message functionality will be implemented and the to address will be ignored if present. If false or not present, then normal message handling is implemented. When set to true, network will use a temporary number to deliver this message. All messages sent by mobile to this temporary number will be stored against the same `messageId`. If a `notifyURL` is provided then user response will be delivered to the URL where `messageId` will be same as `messageId` in reponse to original API request. This field contains the message text, this can be up to 500 UTF-8 characters. As mobile devices rarely support the full range of UTF-8 characters, it is possible that some characters may not be translated correctly by the mobile device. | [optional]
13
+
**priority** | **Boolean** | When messages are queued up for a number, then it is possible to set where a new message will be placed in the queue. If the priority is set to true then the new message will be placed ahead of all messages with a normal priority. If there are no messages queued for the number, then this parameter has no effect. | [optional]
0 commit comments