Send Flash SMS

GET

/v2/flash/send

const url = 'https://api.contacta.mx/v2/flash/send?msg=Hello%20World!&phone=8100001234&sender=AWESOMEINC&id=external-id-relation';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.contacta.mx/v2/flash/send?msg=Hello%20World!&phone=8100001234&sender=AWESOMEINC&id=external-id-relation' \
  --header 'Authorization: Basic <credentials>'

Sends a Flash SMS using query string parameters.

Flash SMS messages are displayed directly on the recipient’s screen without being stored. Suitable for quick tests via browser or Postman.

Authorizations

BasicAuth

Parameters

Query Parameters

msg

required

string

>= 3 characters <= 160 characters

GSM-encoded message (max 160 characters)

Example

Hello World!

phone

required

string

/^\d{10}$/

10-digit destination phone number (Mexico, without country code)

Example

8100001234

sender

string

Sender ID authorized by carrier (optional)

Example

AWESOMEINC

string

External reference ID for your own tracking (optional)

Example

external-id-relation

Responses

200

SMS sent successfully

application/json

object

status

boolean

error

boolean

description

object

added_on

string format: date-time

charge

number format: float

country

object

country

string

iso_code

string

type

string

encoding

string

Allowed values: gsm unicode

integer

job_id

string

length

integer

message

string

number

string

segments

integer

sender

string

Example

{
  "status": true,
  "error": false,
  "description": {
    "added_on": "2023-09-20 16:47:15",
    "charge": 0.99,
    "country": {
      "country": "MEXICO",
      "iso_code": "MX",
      "type": "MOVIL"
    },
    "encoding": "gsm",
    "id": 199999,
    "job_id": "199999",
    "length": 12,
    "message": "Hello World!",
    "number": "8100001234",
    "segments": 1,
    "sender": "AWESOMEINC"
  }
}

400

Missing required parameters

application/json

Example

{
  "status": false,
  "error": true,
  "description": "Missing params, please verify or contact to support"
}

401

Your key auth is not valid

application/json

Example

{
  "status": false,
  "error": true,
  "description": "Your key auth is not valid, please check with your administrator to get the new key"
}

402

Your account doesn’t have credits available for sending

application/json

Example

{
  "status": false,
  "error": true,
  "description": "Your account doesn't have credits available for this, please contact your administrator"
}

406

Country or carrier not reachable or assigned to your account

application/json

Example

{
  "status": false,
  "error": true,
  "description": "Country or carrier not reachable or assigned to your account, please contact an administrator or support"
}

410

Failed to append to the queue, no need to resend

application/json

Example

{
  "status": false,
  "error": true,
  "description": "Failed to append to the queue, no need to resend"
}

411

Your account doesn’t have multi-message sending enabled

application/json

Example

{
  "status": false,
  "error": true,
  "description": "Your account doesn't have multi-message sending enabled, please contact your administrator"
}