Sends an SMS message. - Leadping Documentation

curl --request POST \ --url https://api.leadping.ai/sms/send \ --header 'Content-Type: application/json' \ --data ' { "smsEventId": "<string>", "scheduledFor": "2023-11-07T05:31:56Z", "conversationId": "<string>", "fromPhoneNumberId": "<string>", "wasManuallyOverridden": true, "campaignId": "<string>", "sourceId": "<string>", "text": "<string>" } '

{ "telnyxId": "<string>", "providerMessageId": "<string>", "conversationId": "<string>", "leadId": "<string>", "fromPhoneNumberId": "<string>", "outboundPhoneNumberId": "<string>", "fromPhoneNumber": "<string>", "wasManuallyOverridden": true, "campaignId": "<string>", "sourceId": "<string>", "text": "<string>", "statusReason": "<string>", "queuedAt": "2023-11-07T05:31:56Z", "scheduledFor": "2023-11-07T05:31:56Z", "scheduledReason": "<string>", "sendingStartedAt": "2023-11-07T05:31:56Z", "sentAt": "2023-11-07T05:31:56Z", "deliveredAt": "2023-11-07T05:31:56Z", "receivedAt": "2023-11-07T05:31:56Z", "failedAt": "2023-11-07T05:31:56Z", "undeliverableAt": "2023-11-07T05:31:56Z", "blockedAt": "2023-11-07T05:31:56Z", "nextRetryAt": "2023-11-07T05:31:56Z", "retryCount": "<string>", "canceledAt": "2023-11-07T05:31:56Z", "cancelReason": "<string>", "errorCode": "<string>", "errorMessage": "<string>", "isWarmup": true, "billableAmount": "<string>", "billingStatus": "<string>", "tenDlcCampaignId": "<string>", "complianceAction": "<string>", "id": "<string>", "createdAt": "2023-11-07T05:31:56Z", "modifiedAt": "2023-11-07T05:31:56Z" }

Body

The SMS request containing recipient and message details.

Request payload for send SMS.

smsEventId

string | null

The SMS event ID associated with this SMS.

scheduledFor

string<date-time> | null

The date and time for the scheduled for value on this SMS.

conversationId

string

The conversation ID associated with this SMS.

fromPhoneNumberId

string | null

The from phone number ID associated with this SMS.

selectionReason

enum<string> | null

Defines the supported Outgoing Number Selection Reason values.

Available options:

StickyConversation,

LeadAssigned,

CampaignOrSource,

Preferred,

LocalArea,

HealthyPool,

FallbackDefault,

ManualOverride

wasManuallyOverridden

boolean

Whether this SMS was manually overridden.

campaignId

string | null

The campaign ID associated with this SMS.

sourceId

string | null

The source ID associated with this SMS.

text

string

The text value for this SMS.

Response

The sms response was created successfully.

API response containing SMS data returned to callers.

telnyxId

string | null

The Telnyx ID associated with this SMS.

providerMessageId

string | null

The provider message ID associated with this SMS.

conversationId

string

The conversation ID associated with this SMS.

leadId

string

The lead ID associated with this SMS.

fromPhoneNumberId

string

The from phone number ID associated with this SMS.

outboundPhoneNumberId

string

The outbound phone number ID associated with this SMS.

fromPhoneNumber

string | null

The phone number associated with this SMS.

selectionReason

enum<string> | null

Defines the supported Outgoing Number Selection Reason values.

Available options:

StickyConversation,

LeadAssigned,

CampaignOrSource,

Preferred,

LocalArea,

HealthyPool,

FallbackDefault,

ManualOverride

wasManuallyOverridden

boolean

Whether this SMS was manually overridden.

campaignId

string | null

The campaign ID associated with this SMS.

sourceId

string | null

The source ID associated with this SMS.

text

string

The text value for this SMS.

status

enum<string> | null

Defines the supported SMS Message Status values.

Available options:

draft,

scheduled,

queued,

sending,

sent,

received,

delivered,

failed,

undeliverable,

opted_out,

blocked_compliance,

blocked_billing,

blocked_missing_campaign,

canceled

statusReason

string | null

The human-readable status reason explaining this SMS.

queuedAt

string<date-time> | null

The date and time for the queued at value on this SMS.

scheduledFor

string<date-time> | null

The date and time for the scheduled for value on this SMS.

scheduledReason

string | null

The human-readable scheduled reason explaining this SMS.

sendingStartedAt

string<date-time> | null

The date and time for the sending started at value on this SMS.

sentAt

string<date-time> | null

The date and time for the sent at value on this SMS.

deliveredAt

string<date-time> | null

The date and time for the delivered at value on this SMS.

receivedAt

string<date-time> | null

The date and time for the received at value on this SMS.

failedAt

string<date-time> | null

The date and time for the failed at value on this SMS.

undeliverableAt

string<date-time> | null

The date and time for the undeliverable at value on this SMS.

blockedAt

string<date-time> | null

The date and time for the blocked at value on this SMS.

nextRetryAt

string<date-time> | null

The date and time for the next retry at value on this SMS.

retryCount

string<int32>

The retry count for this SMS.

Pattern: ^-?(?:0|[1-9]\d*)$

canceledAt

string<date-time> | null

The date and time for the canceled at value on this SMS.

cancelReason

string | null

The human-readable cancel reason explaining this SMS.

errorCode

string | null

The error code value for this SMS.

errorMessage

string | null

The error message value for this SMS.

isWarmup

boolean

Whether this SMS is warmup.

trafficType

enum<string> | null

Defines the supported SMS Traffic Type values.

Available options:

RealLead,

Warmup,

Test,

SystemInternal,

FailedAttempt

billableAmount

string<double> | null

The monetary billable amount for this SMS.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$

billingStatus

string | null

The current billing status for this SMS.

tenDlcCampaignId

string | null

The 10DLC campaign ID associated with this SMS.

complianceAction

string | null

The compliance action value for this SMS.

string

createdAt

string<date-time>

modifiedAt

string<date-time> | null