.png?sv=2022-11-02&spr=https&st=2025-09-12T17%3A01%3A10Z&se=2025-09-12T17%3A11%3A10Z&sr=c&sp=r&sig=ZiiISIefkHIFgtj%2FL5zIvcouvCIqlcUzGz%2BjLkeJMgQ%3D){kind=logo}
External Provider
- DarkLight
External Provider
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
An External Server refers to the setup of an external server to integrate with your system for specific functionalities such as SMS messaging, email delivery, or data processing. External servers act as third-party providers that handle tasks beyond the capabilities of your internal system.
Request
{
"externalServerName": "ExampleServer",
“campaign”:”sms_campaign”,
"channelType": "SMS",
"from": "15734754150",
"fromModeName": "SMS",
"to": " 91xxxxxxxxx",
"lcmkey": "249|5|2|0|0|84|41",
"TemplateName": "ramesh_voice_smstemplate1",
"message": "pls respond yes",
"businessFields": [
{
"bussFld1Name": "Bussinesfield1",
"bussFld1Value": "xxxxxx"
}
],
"tenantID": "110000001",
"subTenantID": "41",
"callbackURL": "https://xxxxxx/ITREngine/ITRService/API/"
}
Request Fields
Field | Description |
|---|---|
externalServerName | The name of the external server processing or handling the request. |
campaign | The name of the campaign associated with the message, such as sms_campaign. |
channelType | The type of communication channel being used, such as SMS, Email, or Push Notification. |
from | The sender's identifier or details. |
fromModeName | The mode of communication used for sending the message, such as SMS or Email. |
to | The recipient’s contact information, such as a phone number or email ID. |
lcmkey | A unique key used for tracking or managing the message lifecycle. |
TemplateName | The name of the predefined template used for the message. |
message | The actual content of the message being sent, such as pls respond yes. |
businessFields | A list of business-specific fields containing metadata or additional information. bussFld1Name: The name of a custom business field. bussFld1Value: The value corresponding to the custom business field. |
tenantID | A unique identifier for the tenant using the system. |
subTenantID | A unique identifier for a sub-tenant under the main tenant. |
callbackURL | A URL used by the Httpsmsreceiver application to send status updates or responses to ITREngine. When sending an SMS or response, external systems should return this URL in their response. |
Response
5eeddc3d-0ae8-46d0-bce3-95ea4acd2f2dWas this article helpful?