myxer.sms.send
Send SMS Message
Note: This method requires special permission to use. Contact Myxer to apply.
Depending on how your account is set up, there may be limits placed on how many items or messages a partner
will be allowed to send to a specific phone number before including the pin.
Arguments
- api_key
- Your API application key. See here for more details on api_key.
- method
- myxer.sms.send
- msg
- text message
- pn
- Phone Number - assume North American number unless a country code is included. (i.e. +44)
- pin (may be optional or required)
- Pin code - use the myxer.verification.send method to send the user a pin code. The user must give you this pin code so you can pass it to Myxer to prove the customer owns the phone.
If required but not supplied, you will receive error code 20 - "User must verify phone ownership".
- txId
- Transaction Id - only used when sending a message as an asynchronous reply to callback.sms.notify
- api_sig
- Secure signature of the api parameters. See here for details on api_sig.
Example Response
The response format is a simple XML block.
Success Response
<?xml version="1.0" encoding="utf-8" ?>
<response status="ok">
</response>
Error Response
<?xml version="1.0" encoding="utf-8" ?>
<response status="fail">
<code>[error-code]</code>
<msg>[error-message]</msg>
</response>