HTTP connection

Last update: 7 days ago by Irais Aguirre

The provided web service handles an HTTP POST request, which receives JSON strings and returns a result in the same format.

The following is the information required to connect to the service.


DOMAIN	https://api.broadcastermobile.com
URL	http://[domain]/brdcstr-endpoint-web/services/messaging/
METHOD	POST
HEADERS	Content-Type: application/json Authorization: [token]

Body

{
    "apiKey": [numeric][required],  
    "carrier": [string][optional],  
    "country": [string][required],  
    "dial": [numeric][optional],  
    "message": [String][required],  
    "msisdns": [String[]][required],  
    "tag": [String][required],  
    "mask": [String][optional],  
    "msgClass": [numeric][optional],  
    "schedule":[String][optional][format: ISO-8601],
    "dlr":[Boolean][optional],
    "optionals":[String][optional]
}

Parameters	Description	Required
domain	The path where the service is hosted; Concepto Móvil will provide this information.	Yes
Authorization	A private “token” provided by Concepto Móvil, used as the key to establish the connection.	Yes
apiKey	Client identifier provided by Concepto Móvil. It is unique for each client.	Yes
carrier	Name of the carrier of the MSISDN the message will be sent to. Possible values: TELCEL ATT MOVISTAR They must be entered exactly as shown in the list. If profiling was negotiated, you do not need to send this parameter; the platform will profile the numbers.	No
country	Country identifier (ISO2), two uppercase characters.	Yes
dial	Dial number used to send the message.	Yes
message	Text to send (160 characters). If the text exceeds 160 characters, the platform concatenates the messages in multiples of 153 characters. You must use characters supported by the GSM7 encoding; any character outside this encoding may cause the message to be displayed incorrectly.	Yes
msisdns	10-digit number plus area code that the message will be sent to; it must be enclosed in square brackets.	Yes
tag	Text used to identify the request. It accepts any string you want; we suggest sending the campaign name. Required
mask	Mask text the message should be delivered with. To use masking, this feature must have been agreed upon in advance.	No
schedule	Date and time the message will be sent; it must include the time zone. If this attribute is not included, the message is sent immediately.	No
msgClass	Value that indicates whether the message is a normal or flash message (Normal 0 and Flash 1). If this attribute is not included, it is treated as zero.	No
dlr	Value that indicates whether a DeliveryReceipt notification is required, to be delivered to a URL provided by the client. If set to true, the “registeredDelivery” value is required.	No
optionals	Value used to assign specific variables as needed, in JSON format {“property”:”value”} registeredDelivery: Required if the “dlr” value is specified. Allowed values: 1: Indicates when the carrier has sent the MT to the device. 5: Indicates when the device has received the MT. 11: Indicates when the MT has been sent to the carrier.	No

Example

{  
    "apiKey": 22,  
    "carrier": "Telcel",  
    "country": "mx",  
    "dial": 12345,  
    "message": "Test message",  
    "msisdns": [525512345678],  
    "tag": "Test tag",  
    "mask": "MASCARA",  
    "schedule": "2018-07-01T10:15:30+01:00",
    "dlr":"true",
    "optionals":"{"registeredDelivery":11}"
}

SMS — Previous

Bulk sending

Response