Developers – Xtend Online Media Pvt Ltd

API

API for Developers

A powerful interface designed for developers to seamlessly integrate functionality into their applications. With comprehensive documentation and tools, our API allows for efficient code building, enabling access to data and services to enhance application performance and user experience. Perfect for creating innovative solutions with ease.

SMS API

http://smsapi.xtendonline.com/blank/sms/user/urlsms.php?username=USERNAME&pass=PASSWORD&senderid=SENDER&dest_mobileno=MOBILE_NUMBER&message=YOUR MESSAGE&msgtype=TXT/UNICODE&dltheaderid=DLT_HEADER_ID&dltentityid=DLT_ENTITY_ID&response=Y&dlttempid=DLT_TEMPLATE_ID

Parameters :

username : Username of the account

pass : Password of the account

senderid : Sender ID of the account

dest_mobileno : Receipients Mobile number

message: Your message

msgtype: TXT for English text and UNI for other language text

dltheaderid: Header ID of the Sender

dltentityid: Entity ID of the Entity

dlttempid: Template ID of the template.

SMS Error Codes

SMS error codes are numerical or alphanumeric codes returned by SMS gateways or mobile networks when there’s a problem with sending or receiving text messages. These codes help identify the type of error encountered.

Error_Code	Description
0	Successfully Delivered
1	Unknown subscriber
2	Service temporary not available
3	Unexpected Data Value
4	FWD SM Failure(It is the case, when no response received from oper
5	Unidentified Subscriber
6	EC_ABSENT_SUBSCRIBER_SM
7	Reply path not found\|UNKNOWN EQUIPMENT
8	No Response of SM Delivery Success / Failure status
9	EC_ILLEGAL_SUBSCRIBER
10	System failure (Network timeout)
11	EC_TELESERVICE_NOT_PROVISIONED
12	EC_ILLEGAL_EQUIPMENT
13	EC_CALL_BARRED
14	Not home zone and IMSI fetch failed\|Barred unauthorized message originator
15	SM Delivery fail (Subscriber busy for MT SMS)
18	ESME error\|message waiting for report expired’
19	Originating location mismatch\|SRIAck unsuccessful with any other error codes’
20	Bearer Service Not Supported
21	EC_FACILITY_NOT_SUPPORTED
22	Busy Subscriber
23	Unknown or Unreachable LCS Client ; System failure (unknown error code)
24	Originating reservation denied call case blocked for subscription type\|call forbidden’ ; System failure (unknown error code)
25	Originating reservation denied low balance\|the network does not support SMS’
26	‘teleservice not supported’
27	EC_ABSENT_SUBSCRIBER
29	System failure (No subscriber reply)
30	Terminating reservation failed\|HLR:data lacked’
31	System failure; Terminating reservation denied subscription not found\|EC_SUBSCRIBER_BUSY_FOR_MT_SMS
32	Terminating reservation denied subscription state illegal\|EC_SM_DELIVERY_FAILURE
33	Terminating reservation denied call case blocked for subscription\|EC_MESSAGE_WAITING_LIST_FULL
34	EC_SYSTEM_FAILURE
35	Terminating reservation denied low balance\|EC_DATA_MISSING
36	Unexpected Data Value
37	‘Unmarked Subscriber’
38	‘failure because the subscriber is busy’
39	‘VMSC isolated’
40	Stack/Sig Error Abnormal Map Dialogue
41	Sig Error MAP guard timer expired
42	Sig Error MAP Error in message transport CCIT92
43	Not Supported by equipment
44	Illegal equipment
45	Quarantine Add\|Unspecific PID Error
46	Quarantine Remove\|Message Class Not Supported
47	DCS error
48	TPDU Not Supported
49	Short message delivery failure with memory capacity exceeded
50	Unexpected error from Store\|UNKNOWN ERROR
51	Direct delivery disabled from store\|EC_RESOURCE_LIMITATION
53	Message limit exceeded\|Subscriber Busy For MT-SMS
54	Retry scheme ended\|Data Download Error
60	Originator blocked\|Absent subscriber
61	Destination blocked\|Absent subscriber
62	Keyword blocked\|Absent subscriber
63	SC address blocked\|Absent subscriber
64	Blocked due to exceeded quota\|Absent subscriber
65	Loop detected\|Absent subscriber
66	Data coding scheme blocked\|Absent subscriber over GPRS Page Fail
67	Information element identifier blocked\|Absent subscriber over GPRS Detached
68	Country Code Validation Block\|Absent subscriber over GPRS Deregistered
69	Destination Flooding
70	No ESME provider available\|MS store is full’
71	ESME account not connected\|EC_UNKNOWN_ALPHABET
72	No ESME sub account routing\|EC_USSD_BUSY
74	ESME local throttling – exceeded msg/s\|INVALID HEADER IN MSG
77	SYSTEM_FAILURE
80	Home routing sender GT mismatch\|PENDING DLR (Retry )
81	Location mismatch between provided location and location known to HLR.\|Service not supported
82	IMSI mismatch between provided IMSI \|Mistyped parameter
83	Local throttling by sink\|No response from the peer
84	The IMSI could not be retrieved from the HSS\|Resource limitation
85	The IMEI of the UE is unknown\|Initiating release
86	The user location is unknown\|Unrecognised error
87	ESME router\|Provider Error (In case of any failures observed in TCAP level this error will generate).
88	Network fluctuation from far End Operator(Temporary Error)
89	INVALID PACKET AT SMSC LEVEL
90	USER-ABORT
91	PROVIDER-ABORT
92	MSC NUMBER MISSING
93	Equipment protocol error
94	Equipment not SM equipped
95	Unknown service centre
96	Service Centre congestion
97	INVALID SCHEDULE DELIVERY TIME
98	Subscriber not SC subscriber
99	Memory capacity exceeded
100	PLMN system failure
101	HLR system failure
102	VLR system failure
103	PVLR system failure
104	Controlling MSC system failure
105	Equipment protocol error\|MTP_FAILURE
106	UNKNOWN service centre address\|MS response is overtime’
107	Service centre congestion\|HLR:the subscriber is unregistered’
108	Invalid short message entity address\|ROUTE BLOCKED FOR THIS SERIES
109	Subscriber not service centre subscriber\|MSISDN SERIES NOT CONFIGURED
110	Reject\|NOT ABLE TO GET FINAL ROUTE
111	EC_TEMPLATE_BLOCKED_BY_DLT
112	EC_ENTITY_NOT_FOUND
113	EC_ENTITY_NOT_REGISTERED
114	EC_ENTITY_INACTIVE
115	ROUTE NOT CONFIGURED AT PLATFORM LEVEL
116	EC_INVALID_ENTITY_ID
117	EC_ENTITY_ID_NOT_ALLOWED_FOR_TM
118	EC_TELEMARKETER_NOT_REGISTERED
119	EC_TELEMARKETER_INACTIVE
120	MAP_DLGUA_UsrRsn_NTR_MapNotConfigured
121	MAP_DLGUA_UsrRsn_NTR_OtherErr
122	MAP_DLGRJT_PrvRsn_NotSent
123	INTERNATIONAL ROAMING
124	EC_OR_appContextNotSupported
125	EC_OR_invalidDestinationReference
126	EC_OR_invalidOriginatingReference
127	EC_OR_encapsulatedAC_NotSupported
128	EC_OR_transportProtectionNotAdequate
129	EC_OR_noReasonGiven
130	EC_OR_potentialVersionIncompatibility
131	EC_OR_remoteNodeNotReachable
132	Map Dialog Rejected Refuse Reason: Application Context not supported
133	Map Dialog Rejected Refuse Reason: Potential Version Incompatibility
134	Map Dialog Rejected Refuse Reason: Remote Node not reachable
135	Map Dialog Rejected Provider Reason: Provider malfunction
136	Map Dialog Rejected Provider Reason: Transaction Released
137	Map Dialog Rejected Provider Reason: Resource Limitation
138	Map Dialog Rejected Provider Reason: Maintenance Activity
139	Map Dialog Rejected Provider Reason: Version Incompatibility
140	Map Dialog Rejected Provider Reason: Abnormal Dialogue
141	Map Dialog User Abort Diagnostic Info: Short Term resource Limitation
142	Map Dialog User Abort Diagnostic Info: Long term resource limitation
143	Map Dialog User Abort Diagnostic Info: Handover cancellation
144	Map Dialog User Abort Diagnostic Info: Radio Channel Release
145	Map Dialog User Abort Diagnostic Info: Call Release
146	Map Dialog User Abort Diagnostic Info: Network path Release
147	Map Dialog User Abort Diagnostic Info: Associated Procedure release
148	Map Dialog User Abort Diagnostic Info: Tandem Dialog Release
149	Map Dialog User Abort Diagnostic Info: Remote Operation Failure
150	UNKNOWN subscriber\|Map Dialog User Abort User Reason: User specific reason
151	Call barred\|Map Dialog User Abort User Reason: User resource limitation
152	Teleservice not provisioned\|EC_NNR_noTranslationForAnAddressOfSuchNature
153	Absent subscriber\|EC_NNR_noTranslationForThisSpecificAddress
154	EC_NNR_subsystemCongestion ; Facility not supported\|EC_NNR_subsystemCongestion
155	System failure\|EC_NNR_subsystemFailure
156	Unexpected data value\|EC_NNR_unequippedUser
157	Data missing\|EC_NNR_MTPfailure
158	Memory capacity exceeded\|EC_NNR_networkCongestion
159	Mobile subscriber not reachable\|EC_NNR_unqualified
160	Reject\|EC_NNR_errorInMessageTransportXUDT
161	Local cancel\|EC_NNR_errorInLocalProcessingXUDT
162	Abort\|EC_NNR_destinationCannotPerformReassemblyXUDT
163	Exception\|EC_NNR_SCCPfailure
164	UNKNOWN\|EC_NNR_hopCounterViolation
165	EC_NNR_segmentationNotSupported
166	EC_NNR_segmentationFailure
167	USSD platform Unknown error
168	DND Blocked
169	MAP-P-Abort: Provider reasons
170	MAP-P-Abort Provider reason: Malfunction
171	MAP-P-Abort Provider reason: Dialog Released
172	‘waiting queue in destination subscriber table is full’
173	MAP-P-Abort Provider reason: Abnormal Dialog
174	MAP-P-Abort: Invalid PDU
175	MAP-Open: Out of MAP dialogs
176	Invalid Service code
177	Subscriber MSISDN Blacklisted
178	Subscriber IMSI Blacklisted
179	Invalid Originating Address with Length greater than 20 chars
180	MAP-Open Refuse reason: Node Not Reached
181	‘service barred’
182	‘operation barred’
183	VLRBlackListed
184	VLRWhiteListed
185	MAP-Notice Problem: Message Cannot Be Delivered
186	BILNG_SystemError
187	MAP-Notice: Abnormal event detected by peer
188	MAP-U-Abort: Error
189	MAP-U-Abort User Reason: User Specific Reason
190	MAP-U-Abort: User resource limitation
191	MAP-U-Abort: Resource unavailable (short term)
192	Unexpected session release from Servers/3rd party APP
193	‘unknServCent’
194	‘sc_Congestion’
195	‘invaSME_Add’
196	‘subsNotSC_Subsc’
197	Application Specific Error from Client
198	MAP-U-Abort: Application procedure cancellation (tandem dialogue released)
199	MAP-U-Abort: Application procedure cancellation (remote operations failure)
200	Consent given
201	Absent subscriber \| System failure
202	Invalid service type
203	Subscriber busy for MT-SMS\|Unknown MSC
204	EC_IMSI_BLACKLISTED
205	EC_BLACKLISTED_DESTINATIONADDRESS
206	Invalid destination flag
207	Invalid source address numbering plan ( NPI )
208	Invalid destination address numbering plan ( NPI )
209	Invalid scheduled delivery time
210	ESME Receiver permanent error
211	Equipment protocol error\|SS Error Status
212	Equipment not short message equipped\|SS Not Available
213	Reject\|SS Subscription Violation
214	Local cancel\|SS Incompatible
215	Abort\|HLR:limited due to MS roaming’
216	DND Block
217	UNKNOWN\|Internal IPC Router Failure
218	‘HLR:illegal subscriber’
219	Error in the optional part of the PDU body
220	‘HLR:the called MS poweroff’
221	MSISDN BLOCKED
222	MESSAGE CONTENT IS BLACKLISTED/EC_Network System Failure
223	Data Missing
224	Unexpected Data
225	ESME not authorised to use specified servicetype
226	Invalid data coding scheme
227	IN Subscriber not exist1
228	‘the destination subscriber PPS authentication overtime’
229	‘IN Invalid subscriber’
230	Incorrect bin/head/normal user data parameter combination
231	Incorrect cancel enabled parameter usage
232	Incorrect alpha originator address usage
233	Resource Limitation
234	Unauthorized Requesting Network
235	Unathorized LCS Client
236	Position Method Failure
237	Custom error 8
238	Custom error 9
239	Custom error 10
240	Recipient Temporary Error
241	Recipient Permanent Error
242	Service Not configured/for a particular circle/subscriber. Or simply menu is incomplete or service i
243	Terminating session due to invalid input
244	Unspecific
245	‘HLR:the remote address not reachable’ /’VMSC:Invalid Destination’
246	Client Resource Not Available
247	Unknown Alphabet
248	EC_TIME_OUT
249	EC_IMSI_BLACKLISTED
250	EC_DEST_ADDRESS_BLACKLISTED
251	EC_InvalidMscAddress
252	EC_BLACKLISTED_DESTINATIONADDRESS
253	EC_BLACKLISTED_SENDERADDRESS
254	Personal service barring\|any other error code other than 255
255	Personal service barring\|EC_UNKNOWN_ERROR
256	EC_SM_DF_memoryCapacityExceeded
257	EC_SM_DF_equipmentProtocolError
258	EC_SM_DF_equipmentNotSM_Equipped
259	EC_SM_DF_unknownServiceCentre
260	EC_SM_DF_sc_Congestion
261	EC_SM_DF_invalidSME_Address
262	EC_SM_DF_subscriberNotSC_Subscriber
263	MO Handover: Destination SME Barred
264	MO Handover: Duplicate Message Rejected
265	MO Handover: Validity Period Format Unsupported
266	MO Handover: Validity Period Unsupported
267	MO Handover: Not Supported by equipment
268	MO Handover: System Error
269	MO Handover: Duplicated invoke id
270	MO Handover: Service not supported
271	MO Handover: Mistyped parameter
272	MO Handover: No response from the peer
273	MO Handover: Resource limitation
274	MO Handover: Initiating release
275	Error Gateway
276	MO Handover: Unexpected error
277	MO Handover: Unexpected response from the peer
278	MO Handover: Unable to complete operation within timeout
279	MO Handover: Invalid response received
280	Error\|MO Handover: TCAP error
281	EC_UA_userSpecificReason
282	EC_UA_userResourceLimitation
283	EC_UA_resourceUnavailable
284	EC_UA_applicationProcedureCancellation
285	MO Handover: Unexpected Data Value
286	MO Handover: Telematic Interworking not Supported
287	MO Handover: FDA throttled
288	MO Handover: SM decoding problem
300	Invalid destination address\|Provider Error Duplicate Invoke ID
301	Invalid destination numbering plan\|Provider Error Service Not Supported
302	Invalid destination type of number\|Provider Error Mistyped Paramter
303	Invalid destination flag\|Provider Error Resource Limitation
304	Invalid number of destinations\|Provider Error Initiating Release
305	Provider Error Unexpected Response
306	Provider Error Service Completion Failure
307	EC_Provider No Response from Peer
308	Provider Error Invalid Response
400	DLT_SCRUBBING_TIMEOUT
401	Stack/Sig Error Map User specific Reason
402	Stack/Sig Error Map User Resource Limitation
403	Stack/Sig Error Map Resource Unavailable
404	Stack/Sig Error Map Application Procedure Cancellation
407	EC_HLR/MSC Timeout
409	Unknown Error
410	EC_Cancelled
411	EC_ValidityExpired
412	EC_NotSubmittedToSmppChannel
413	EC_DESTINATION_FLOODING
414	EC_DESTINATION_TXT_FLOODING
415	EC_ENTITY_BLACKLISTED
416	EC_BLOCKED_BY_DLT
417	EC_DLT_SCRUBBING_TIMEOUT
418	EC_SENDER_BLOCKED_BY_DLT
419	EC_TELEMARKETER_BLOCKED_BY_DLT
420	EC_TELEMARKETER_BLACKLISTED
421	EC_HEADER_NOT_FOUND
422	EC_HEADER_INACTIVE
423	EC_HEADER_BLACKLISTED
424	EC_PEID_NOT_MATCHED_WITH_HEA DER
425	EC_HEADER_IN_FREEPOOL
426	EC_TEMPLATE_NOT_FOUND
427	EC_TEMPLATE_INACTIVE
428	EC_TEMPLATE_BLACKLISTED
429	EC_TEMPLATE_NOT_MATCHED
430	EC_HEADER_NOT_REGISTERED_FOR_ TEMPLATE
431	EC_TEMPLATE_VARIABLE_EXCEEDED _MAX_LENGTH
432	EC_ERROR_IDENTIFYING_TEMPLATE
433	EC_INVALID_TEMPLATE_ID
434	EC_TEMPLATE_NOT_REGISTERED_TO _ENTITY
435	EC_PROMOTIONAL_TEMPLATE_USED _ON_OTHERS_HEADER
436	EC_INVALID_TEMPLATE_TYPE ; Duplicate Number within 30 Min
437	EC_PREFERENCE_NOT_MATCHED
438	EC_INVALID_PROMO_TIME
439	EC_SE_CATEGORY_BLOCK
440	EC_CONSENT_FAILED
441	EC_SCRUBBING_FAILED
496	EC_InvalidPduFormat
497	EC_NotSubmittedToGMSC
500	EC_PROVIDER_GENERAL_ERROR
501	Insufficient Balance
502	EC_NO_RESPONSE
503	EC_SERVICE_COMPLETION_FAILURE
504	EC_UNEXPECTED_RESPONSE_FROM_PEER
507	EC_MISTYPED_PARAMETER
508	EC_NOT_SUPPORTED_SERVICE
509	EC_DUPLICATED_INVOKE_ID
510	If Category is 0 or 50. ; Blocked by DLT
511	EC_INITIATING_RELEASE
520	Entity_ID_Not_Matched
521	Sender blocked by DLT
530	Content Blacklisted ; Template error,Content ID not in DB
531	Content Multipart not complete, Content Active/Inactive, Variable Exceeded Error
536	EC_PA_providerMalfunction
537	EC_PA_supportingDialogOrTransactionRealeased
538	EC_PA_ressourceLimitation
539	EC_PA_maintenanceActivity
540	EC_PA_versionIncompatibility ; Template error
541	EC_PA_abnormalMapDialog
550	CONSENT_FAILED
600	ENTITY_NOT_FOUND
601	ENTITY_NOT_REGISTERED
602	ENTITY_INACTIVE
603	ENTITY_BLACKLISTED
604	INVALID_ENTITY_ID
605	ENTITY_ID_NOT_ALLOWED_FOR_TM
604 – 609	ENTITY_RESERVED
610	TELEMARKETER_NOT_REGISTERED
611	TELEMARKETER_INACTIVE
612	TELEMARKETER_BLACKLISTED
620	HEADER_NOT_FOUND
621	HEADER_INACTIVE
622	HEADER_BLACKLISTED
623	PEID_NOT_MATCHED_WITH_HEADER
623- 629	HEADER_RESERVED
630	TEMPLATE_NOT_FOUND
631	TEMPLATE_INACTIVE
632	TEMPLATE_BLACKLISTED
633	TEMPLATE_NOT_MATCHED
634	HEADER_NOT_REGISTERED_FOR_TEMPLATE
635	TEMPLATE_VARIABLE_EXCEEDED_MAX_LENGTH
636	ERROR_IDENTIFYING_TEMPLATE
637	INVALID_TEMPLATE_ID
637 – 649	TEMPLATE_RESERVED
650	PREFERENCE_NOT_MATCHED
651	INVALID_PROMO_TIME
652	SE_CATEGORY_BLOCK
651 – 659	PREFERENCE_RESERVED (Partial or Full DND)
660	CONSENT_FAILED
670	SCRUBBING_FAILED
700	ENTITY_ID_ERROR
703	Submit_SM_Timeout
715	Expired
792	EC_NC_abnormalEventDetectedByPeer
793	EC_NC_responseRejectedByPeer
794	EC_NC_abnormalEventReceivedFromPeer
795	EC_NC_messageCannotBeDeliveredToPeer
796	EC_NC_providerOutOfInvoke
801	EC_BLACKLISTED_MSISDN
804	Message Multipart not complete within the time frame
951	Number Blacklisted
952	DND Rejected
953	Invalid Senderid
954	Invalid Number
955	Insufficient sms Balance
956	Promotional sms pushed after 9 p.m to 10 a.m
959	Account Expired
20A	Bearer Service Not Supported
20B	Tele Service Not Provisioned
20C	Error Equipment
20D	Call Barred
20E	Error Forward Violation
20F	Error CUG Reject
21A	Subsequent Handover Failure
21B	Absent Subscriber for MT
21C	Incompatible Terminal
21D	Short Term Denial
21E	Long Term Denial
21F	Subscriber Busy for MT
22C	Number of PW attempts Violation
22D	Busy Subscriber
22E	No Subscriber Reply
22F	Forwarding Failed
23A	Unknown or Unreachable LCS Client
40A	Stack/Sig Error Map Provider Malfunction
40B	Stack/Sig Error Map Unrecognised Transaction ID
40C	Stack/Sig Error Dialog Resource Limitation
40D	Stack/Sig Error Map Maintenance Activity
40E	Stack/Sig Error Map Version Incompatibility
40F	Stack/Sig Error Abnormal Map Dialogue
41A	Sig Error Map guard Timer Expired
41B	Sig Error Map SPCAUSE mask
41C	Sig Error MAP No Translation Basd Address
41D	Sig Error MAP No Translation specific address
41E	Stack/Sig Application Context Not Supported
41F	Stack/Sig Dlg Invalid Destination Reference
42A	Sig Error MAP Un Equipped User
42B	Sig Error MAP Network Failure
42C	Sig Error MAP Network Conjestion
42D	Sig Error MAP un Qualified
42E	Sig Error MAP HOP Counter violaion ANS92
42F	Sig Error MAP Error in message transport CCIT92
606 – 609	ENTITY_RESERVED
613-619	TELEMARKETER_RESERVED
624-629	HEADER_RESERVED
638-649	TEMPLATE_RESERVED
653-659	PREFERENCE_RESERVED
661-669	CONSENT_RESERVED
671-699	SCRUBBING_RESERVED
999	Number blacklisted at operator end
997	Invalid SenderID and Throttle (Throttle – restricting the flow of messages. )
804	operator connections was not responding at that time and the long messages was not sent within time frame of 120 sec, due to this messages were failed with error code 804.

WhatsAPP API

Allowed HTTP Request

GET
POST

Allowed Data Format

Plain/Text
JSON

Description of usual server responses

200 OK – the request was successful.
201 Created – the request was successful and a resource was created.
204 No Content – the request was successful but there is no representation to return (i.e. the response is empty)
400 Bad Request – the request could not be understood or was missing required
401 Unauthorized – authentication failed or user doesn’t have permissions for requested operation.
403 Forbidden – access denied.
404 Not Found – resource was not found.
405 Method Not Allowed – requested method is not supported for resources.

Message API

Send Text Message

Url : https://waba.xtendonline.com/v3/{{phone_number_id}}/messages

Description : This API is used to send the text message to the end user.

Method : POST

Header:

Name	Value
Content-Type	application/json
apikey	YOUR_WABA_API_KEY

Sample Request:

{

“messaging_product”: “whatsapp”, “preview_url”: false, “recipient_type”: “individual”,

“to”: “{{Recipient-Phone-Number}}“, “type”: “text”,

“text”: {

“body”: “Sample-text”

}

Sample Response:

{

“messaging_product”: “whatsapp”, “contacts”: [

{

“input”: “9175XXXXXXXX”, “wa_id”: “9175XXXXXXXX”

}

“messages”: [

{

“id”: “wamid.HBgMOTE3OTcyODkyNzEyFQIAERgSQUM3MzRCRjdFREYzOENDNTgwAA=

=”

}

]

}