import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const response = await client.messages.cancelScheduled('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
console.log(response.id);{
"record_type": "message",
"direction": "outbound",
"id": "40385f64-5717-4562-b3fc-2c963f66afa6",
"type": "SMS",
"messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6",
"organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950",
"from": {
"phone_number": "+18445550001",
"carrier": "TELNYX LLC",
"line_type": "VoIP"
},
"to": [
{
"phone_number": "+18665550001",
"status": "cancelled",
"carrier": "T-MOBILE USA, INC.",
"line_type": "Wireless"
}
],
"cc": [],
"text": "Hello, World!",
"subject": "From Telnyx!",
"media": [],
"webhook_url": "https://www.example.com/hooks",
"webhook_failover_url": "https://backup.example.com/hooks",
"encoding": "GSM-7",
"parts": 1,
"tags": [
"Greetings"
],
"cost": {
"amount": 0,
"currency": null
},
"cost_breakdown": null,
"tcr_campaign_id": "TCPA3X7",
"tcr_campaign_billable": true,
"tcr_campaign_registered": "REGISTERED",
"received_at": "2019-01-23T18:10:02.574Z",
"sent_at": null,
"completed_at": null,
"valid_until": null,
"errors": []
}Cancel a scheduled message that has not yet been sent. Only messages with status=scheduled and send_at more than a minute from now can be cancelled.
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const response = await client.messages.cancelScheduled('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
console.log(response.id);{
"record_type": "message",
"direction": "outbound",
"id": "40385f64-5717-4562-b3fc-2c963f66afa6",
"type": "SMS",
"messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6",
"organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950",
"from": {
"phone_number": "+18445550001",
"carrier": "TELNYX LLC",
"line_type": "VoIP"
},
"to": [
{
"phone_number": "+18665550001",
"status": "cancelled",
"carrier": "T-MOBILE USA, INC.",
"line_type": "Wireless"
}
],
"cc": [],
"text": "Hello, World!",
"subject": "From Telnyx!",
"media": [],
"webhook_url": "https://www.example.com/hooks",
"webhook_failover_url": "https://backup.example.com/hooks",
"encoding": "GSM-7",
"parts": 1,
"tags": [
"Greetings"
],
"cost": {
"amount": 0,
"currency": null
},
"cost_breakdown": null,
"tcr_campaign_id": "TCPA3X7",
"tcr_campaign_billable": true,
"tcr_campaign_registered": "REGISTERED",
"received_at": "2019-01-23T18:10:02.574Z",
"sent_at": null,
"completed_at": null,
"valid_until": null,
"errors": []
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The id of the message to cancel
Successful response
Identifies the type of the resource.
message "message"
The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you.
outbound "outbound"
Identifies the type of resource.
The type of message.
SMS, MMS Unique identifier for a messaging profile.
The id of the organization the messaging profile belongs to.
Show child attributes
Show child attributes
Receiving address (+E.164 formatted phone number or short code).
The delivery status of the message.
scheduled, queued, sending, sent, cancelled, expired, sending_failed, delivery_unconfirmed, delivered, delivery_failed The carrier of the receiver.
The line-type of the receiver.
Wireline, Wireless, VoWiFi, VoIP, Pre-Paid Wireless, Message body (i.e., content) as a non-empty string.
Required for SMS
Subject of multimedia message
The URL where webhooks related to this message will be sent.
The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.
Encoding scheme used for the message body.
Number of parts into which the message's body must be split.
1 <= x <= 10Tags associated with the resource.
Detailed breakdown of the message cost components.
Show child attributes
The Campaign Registry (TCR) campaign ID associated with the message.
Indicates whether the TCR campaign is billable.
The registration status of the TCR campaign.
"REGISTERED"
ISO 8601 formatted date indicating when the message request was received.
ISO 8601 formatted date indicating when the message was sent.
ISO 8601 formatted date indicating when the message was finalized.
Message must be out of the queue by this time or else it will be discarded and marked as 'sending_failed'. Once the message moves out of the queue, this field will be nulled
These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses.
Show child attributes
Was this page helpful?