MyMobileAPI. mymobileapi.com. to SMS

Transcription

1 MyMobileAPI mymobileapi.com

2 TABLE OF CONTENTS Introduction... 3 Single SMS - How to send... 3 Single SMS - Example of ing... 4 Bulk SMS - How to... 5 Bulk SMS - Example of ing... 6

3 page 3/6 INTRODUCTION This guide contains instructions on how to send an SMS via using any client. There are two methods available, send a single SMS or send bulk/multiple SMS s from one account. SINGLE SMS - HOW TO SEND The following settings are available. Those in red are mandatory. All s must be addressed to <mobilephonenumber>@mymobileapi.com and must contain the correctly formatted subject line, have a from address and contain a message Field Subject Description Your address The address must start with a mobile number and contain the domain in the address. E.g @mymobileapi.com. Only one address will be accepted. Options: All options must be separated by braces. [un=myusername] Your portal username [pw=mypassword] Your portal password [ack=1] When set to 1, we will send an acknowledgment via that the to SMS request was received, and if it was processed. [fwdmo=1] fwdmo can be set to [fwdmo=1] or [fwdmo=example@ .com] When fwdmo is set to [fwdmo=1] replies will be sent to your otherwise when fwdmo is set to [fwdmo=example@ .com] replies will be sent to the valid address specified (in this case example@ .com) An example of a corrrectly formatted subject line: [un=xxx][pw=123][ack=1][fwdmo=1] Body B The message you wish to send to the mobile phone. This can be in plain text or HTML. All html tags will be stripped from the message and only the text will be sent.

4 page 4/6 Single SMS - Example of ing 1. The subject line contains the minimum required information, un and pw [un=xxx][pw=123] - Message (HTML) @mymobileapi.com [un=xxx][pw=123] This is my message. 2. The subject line contains the minimum required information, un and pw, and the optional parameters, ack and fwdmo. [un=xxx][pw=123] - Message (HTML) @mymobileapi.com [un=xxx][pw=123][ack=1][fwdmo=1] This is my message.

5 page 5/6 BULK SMS - HOW TO SEND The following settings are available. Those in red are required All s must be addressed to bulk@mymobileapi.com and must contain the correctly formatted subject line, have a from address and contain a message. Field Subject Description Your address The address must be bulk@mymobileapi.com when sending to multiple mobile phone numbers from one Only one address will be accepted. Options: All options must be separated by braces. [un=myusername] Your portal username [pw=mypassword] Your portal password [ack=1] When set to 1, we will send an acknowledgment via that the to SMS request was received, and if it was processed. [fwdmo=1] fwdmo can be set to [fwdmo=1] or [fwdmo=example@ .com] When fwdmo is set to [fwdmo=1] replies will be sent to your otherwise when fwdmo is set to [fwdmo=example@ .com] replies will be sent to the valid address specified (in this case example@ .com) Example of a corrrectly formatted subject line: [un=xxx][pw=123][ack=1][fwdmo=1] Body Each line item in the body must consist of the following information: Phonenumber Message CustomerId (optional) And is separated by the tilde ~ (above the 1 or left of the one key on the keyboard) Example of layout: ~ test message 1~customerid(unique ref code) ~ test message 2~customerid(unique ref code) ~ test message 3~customerid(unique ref code) B

6 page 6/6 Bulk SMS - Example of ing The subject line contains the minimum required information, un and pw, and a line item for each sms that needs to be sent. [un=xxx][pw=123] - Message (HTML) bulk@mymobileapi.com [un=xxx][pw=123] ~ test message 1~customerid(unique ref code) ~ test message 2~customerid(unique ref code) ~ test message 3~customerid(unique ref code) 2. The subject line contains the minimum required information, un and pw, and the optional parameters, ack and fwdmo [un=xxx][pw=123][ack=1][fwdmo=@ .com] - Message (HTML) bulk@mymobileapi.com [un=xxx][pw=123][ack=1][fwdmo=example@ .com] ~ test message ~ test message ~ test message 3