{ "opencollection": "1.0.0", "info": { "name": "Telnyx Access Tokens TeXML REST Commands API", "version": "2.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "TeXML REST Commands", "type": "folder" }, "items": [ { "info": { "name": "Fetch multiple call resources", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "Page", "value": "1", "type": "query", "description": "The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken." }, { "name": "PageSize", "value": "10", "type": "query", "description": "The number of records to be displayed on a page" }, { "name": "PageToken", "value": "", "type": "query", "description": "Used to request the next page of results." }, { "name": "To", "value": "+1312345678", "type": "query", "description": "Filters calls by the to number." }, { "name": "From", "value": "+1312345678", "type": "query", "description": "Filters calls by the from number." }, { "name": "Status", "value": "no-answer", "type": "query", "description": "Filters calls by status." }, { "name": "StartTime", "value": "2023-05-22", "type": "query", "description": "Filters calls by their start date. Expected format is YYYY-MM-DD." }, { "name": "StartTime_gt", "value": "2023-05-22", "type": "query", "description": "Filters calls by their start date (after). Expected format is YYYY-MM-DD" }, { "name": "StartTime_lt", "value": "2023-05-22", "type": "query", "description": "Filters calls by their start date (before). Expected format is YYYY-MM-DD" }, { "name": "EndTime", "value": "2023-05-22", "type": "query", "description": "Filters calls by their end date. Expected format is YYYY-MM-DD" }, { "name": "EndTime_gt", "value": "2023-05-22", "type": "query", "description": "Filters calls by their end date (after). Expected format is YYYY-MM-DD" }, { "name": "EndTime_lt", "value": "2023-05-22", "type": "query", "description": "Filters calls by their end date (before). Expected format is YYYY-MM-DD" } ] }, "docs": "Returns multiple call resouces for an account. This endpoint is eventually consistent." }, { "info": { "name": "Initiate an outbound call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiate an outbound TeXML call. Telnyx will request TeXML from the XML Request URL configured for the connection in the Mission Control Portal." }, { "info": { "name": "Fetch a call", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid", "params": [ { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." }, { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." } ] }, "docs": "Returns an individual call identified by its CallSid. This endpoint is eventually consistent." }, { "info": { "name": "Update call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid", "params": [ { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." }, { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Update TeXML call. Please note that the keys present in the payload MUST BE formatted in CamelCase as specified in the example." }, { "info": { "name": "Fetch recordings for a call", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid/Recordings.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." } ] }, "docs": "Returns recordings for a call identified by call_sid." }, { "info": { "name": "Request recording for a call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid/Recordings.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Starts recording with specified parameters for call idientified by call_sid." }, { "info": { "name": "Update recording on a call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid/Recordings/:recording_sid.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." }, { "name": "recording_sid", "value": "", "type": "path", "description": "Uniquely identifies the recording by id." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates recording resource for particular call." }, { "info": { "name": "Request siprec session for a call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid/Siprec.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Starts siprec session with specified parameters for call idientified by call_sid." }, { "info": { "name": "Updates siprec session for a call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid/Siprec/:siprec_sid.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." }, { "name": "siprec_sid", "value": "", "type": "path", "description": "The SiprecSid that uniquely identifies the Sip Recording." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates siprec session identified by siprec_sid." }, { "info": { "name": "Start streaming media from a call.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid/Streams.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Starts streaming media from a call to a specific WebSocket address." }, { "info": { "name": "Update streaming on a call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid/Streams/:streaming_sid.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." }, { "name": "streaming_sid", "value": "", "type": "path", "description": "Uniquely identifies the streaming by id." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates streaming resource for particular call." }, { "info": { "name": "List conference resources", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "Page", "value": "1", "type": "query", "description": "The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken." }, { "name": "PageSize", "value": "10", "type": "query", "description": "The number of records to be displayed on a page" }, { "name": "PageToken", "value": "", "type": "query", "description": "Used to request the next page of results." }, { "name": "FriendlyName", "value": "weekly_review_call", "type": "query", "description": "Filters conferences by their friendly name." }, { "name": "Status", "value": "in-progress", "type": "query", "description": "Filters conferences by status." }, { "name": "DateCreated", "value": ">=2023-05-22", "type": "query", "description": "Filters conferences by the creation date. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. DateCreated>=2023-05-22." }, { "name": "DateUpdated", "value": ">=2023-05-22", "type": "query", "description": "Filters conferences by the time they were last updated. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. DateUpdated>=2023-05-22." } ] }, "docs": "Lists conference resources." }, { "info": { "name": "Fetch a conference resource", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." } ] }, "docs": "Returns a conference resource." }, { "info": { "name": "Update a conference resource", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates a conference resource." }, { "info": { "name": "List conference participants", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid/Participants", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." } ] }, "docs": "Lists conference participants" }, { "info": { "name": "Dial a new conference participant", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid/Participants", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Dials a new conference participant" }, { "info": { "name": "Get conference participant resource", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid/Participants/:call_sid_or_participant_label", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." }, { "name": "call_sid_or_participant_label", "value": "", "type": "path", "description": "CallSid or Label of the Participant to update." } ] }, "docs": "Gets conference participant resource" }, { "info": { "name": "Update a conference participant", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid/Participants/:call_sid_or_participant_label", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." }, { "name": "call_sid_or_participant_label", "value": "", "type": "path", "description": "CallSid or Label of the Participant to update." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates a conference participant" }, { "info": { "name": "Delete a conference participant", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid/Participants/:call_sid_or_participant_label", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." }, { "name": "call_sid_or_participant_label", "value": "", "type": "path", "description": "CallSid or Label of the Participant to update." } ] }, "docs": "Deletes a conference participant" }, { "info": { "name": "List conference recordings", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid/Recordings", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." } ] }, "docs": "Lists conference recordings" }, { "info": { "name": "Fetch recordings for a conference", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid/Recordings.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." } ] }, "docs": "Returns recordings for a conference identified by conference_sid." }, { "info": { "name": "List queue resources", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Queues", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "Page", "value": "1", "type": "query", "description": "The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken." }, { "name": "PageSize", "value": "10", "type": "query", "description": "The number of records to be displayed on a page" }, { "name": "PageToken", "value": "", "type": "query", "description": "Used to request the next page of results." }, { "name": "DateCreated", "value": ">=2023-05-22", "type": "query", "description": "Filters conferences by the creation date. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. DateCreated>=2023-05-22." }, { "name": "DateUpdated", "value": ">=2023-05-22", "type": "query", "description": "Filters conferences by the time they were last updated. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. DateUpdated>=2023-05-22." } ] }, "docs": "Lists queue resources." }, { "info": { "name": "Create a new queue", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Queues", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Creates a new queue resource." }, { "info": { "name": "Fetch a queue resource", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Queues/:queue_sid", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "queue_sid", "value": "", "type": "path", "description": "The QueueSid that identifies the call queue." } ] }, "docs": "Returns a queue resource." }, { "info": { "name": "Update a queue resource", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Queues/:queue_sid", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "queue_sid", "value": "", "type": "path", "description": "The QueueSid that identifies the call queue." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates a queue resource." }, { "info": { "name": "Delete a queue resource", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Queues/:queue_sid", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "queue_sid", "value": "", "type": "path", "description": "The QueueSid that identifies the call queue." } ] }, "docs": "Delete a queue resource." }, { "info": { "name": "Fetch multiple recording resources", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Recordings.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "Page", "value": "1", "type": "query", "description": "The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken." }, { "name": "PageSize", "value": "10", "type": "query", "description": "The number of records to be displayed on a page" }, { "name": "DateCreated", "value": "", "type": "query", "description": "Filters recording by the creation date. Expected format is ISO8601 date or date-time, ie. {YYYY}-{MM}-{DD} or {YYYY}-{MM}-{DD}T{hh}:{mm}:{ss}Z. Also accepts inequality operators, e.g. DateCreated>=2023-05-22." } ] }, "docs": "Returns multiple recording resources for an account." }, { "info": { "name": "Fetch recording resource", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Recordings/:recording_sid.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "recording_sid", "value": "", "type": "path", "description": "Uniquely identifies the recording by id." } ] }, "docs": "Returns recording resource identified by recording id." }, { "info": { "name": "Delete recording resource", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Recordings/:recording_sid.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "recording_sid", "value": "", "type": "path", "description": "Uniquely identifies the recording by id." } ] }, "docs": "Deletes recording resource identified by recording id." }, { "info": { "name": "List recording transcriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Transcriptions.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "PageToken", "value": "", "type": "query", "description": "Used to request the next page of results." }, { "name": "PageSize", "value": "10", "type": "query", "description": "The number of records to be displayed on a page" } ] }, "docs": "Returns multiple recording transcription resources for an account." }, { "info": { "name": "Fetch a recording transcription resource", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Transcriptions/:recording_transcription_sid.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "recording_transcription_sid", "value": "", "type": "path", "description": "Uniquely identifies the recording transcription by id." } ] }, "docs": "Returns the recording transcription resource identified by its ID." }, { "info": { "name": "Delete a recording transcription", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Transcriptions/:recording_transcription_sid.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "recording_transcription_sid", "value": "", "type": "path", "description": "Uniquely identifies the recording transcription by id." } ] }, "docs": "Permanently deletes a recording transcription." }, { "info": { "name": "Initiate an outbound AI call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/ai_calls/:connection_id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "The ID of the TeXML connection to use for the call." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiate an outbound AI call with warm-up support. Validates parameters, builds an internal TeXML with an AI Assistant configuration, encodes instructions into client state, and calls the dial API. The Twiml, Texml, and Url parameters are not allowed and will result in a 422 error." }, { "info": { "name": "Create a TeXML secret", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/secrets", "body": { "type": "json", "data": "{}" } }, "docs": "Create a TeXML secret which can be later used as a Dynamic Parameter for TeXML when using Mustache Templates in your TeXML. In your TeXML you will be able to use your secret name, and this name will be replaced by the actual secret value when processing the TeXML on Telnyx side. The secrets are not visible in any logs." } ] } ], "bundled": true }