> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # twilio-voice > Twilio Voice - Calls, conferences, queues, and recordings **Server path:** `/twilio-voice` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`twilio_voice_create_call`](#twilio_voice_create_call) | Create a new outgoing call to phones, SIP-enabled endpoints or Twilio Client connections | | [`twilio_voice_create_call_recording`](#twilio_voice_create_call_recording) | Create a recording for the call | | [`twilio_voice_create_message_feedback`](#twilio_voice_create_message_feedback) | Create Message Feedback to confirm a tracked user action was performed by the recipient of the associated Message | | [`twilio_voice_create_participant`](#twilio_voice_create_participant) | POST /Conferences/\{ConferenceSid}/Participants.json | | [`twilio_voice_create_payments`](#twilio_voice_create_payments) | create an instance of payments. This will start a new payments session | | [`twilio_voice_create_queue`](#twilio_voice_create_queue) | Create a queue | | [`twilio_voice_create_realtime_transcription`](#twilio_voice_create_realtime_transcription) | Create a Transcription | | [`twilio_voice_create_siprec`](#twilio_voice_create_siprec) | Create a Siprec | | [`twilio_voice_create_stream`](#twilio_voice_create_stream) | Create a Stream | | [`twilio_voice_create_user_defined_message`](#twilio_voice_create_user_defined_message) | Create a new User Defined Message for the given Call SID. | | [`twilio_voice_create_user_defined_message_subscription`](#twilio_voice_create_user_defined_message_subscription) | Subscribe to User Defined Messages for a given Call SID. | | [`twilio_voice_delete_call`](#twilio_voice_delete_call) | Delete a Call record from your account. Once the record is deleted, it will no longer appear in the API and Account Portal logs. | | [`twilio_voice_delete_call_recording`](#twilio_voice_delete_call_recording) | Delete a recording from your account | | [`twilio_voice_delete_conference_recording`](#twilio_voice_delete_conference_recording) | Delete a recording from your account | | [`twilio_voice_delete_participant`](#twilio_voice_delete_participant) | Kick a participant from a given conference | | [`twilio_voice_delete_queue`](#twilio_voice_delete_queue) | Remove an empty queue | | [`twilio_voice_delete_user_defined_message_subscription`](#twilio_voice_delete_user_defined_message_subscription) | Delete a specific User Defined Message Subscription. | | [`twilio_voice_fetch_call`](#twilio_voice_fetch_call) | Fetch the call specified by the provided Call SID | | [`twilio_voice_fetch_call_notification`](#twilio_voice_fetch_call_notification) | GET /Calls/\{CallSid}/Notifications/\{Sid}.json | | [`twilio_voice_fetch_call_recording`](#twilio_voice_fetch_call_recording) | Fetch an instance of a recording for a call | | [`twilio_voice_fetch_conference`](#twilio_voice_fetch_conference) | Fetch an instance of a conference | | [`twilio_voice_fetch_conference_recording`](#twilio_voice_fetch_conference_recording) | Fetch an instance of a recording for a call | | [`twilio_voice_fetch_member`](#twilio_voice_fetch_member) | Fetch a specific member from the queue | | [`twilio_voice_fetch_participant`](#twilio_voice_fetch_participant) | Fetch an instance of a participant | | [`twilio_voice_fetch_queue`](#twilio_voice_fetch_queue) | Fetch an instance of a queue identified by the QueueSid | | [`twilio_voice_list_call`](#twilio_voice_list_call) | Retrieves a collection of calls made to and from your account | | [`twilio_voice_list_call_notification`](#twilio_voice_list_call_notification) | GET /Calls/\{CallSid}/Notifications.json | | [`twilio_voice_list_call_recording`](#twilio_voice_list_call_recording) | Retrieve a list of recordings belonging to the call used to make the request | | [`twilio_voice_list_conference`](#twilio_voice_list_conference) | Retrieve a list of conferences belonging to the account used to make the request | | [`twilio_voice_list_conference_recording`](#twilio_voice_list_conference_recording) | Retrieve a list of recordings belonging to the call used to make the request | | [`twilio_voice_list_member`](#twilio_voice_list_member) | Retrieve the members of the queue | | [`twilio_voice_list_participant`](#twilio_voice_list_participant) | Retrieve a list of participants belonging to the account used to make the request | | [`twilio_voice_list_queue`](#twilio_voice_list_queue) | Retrieve a list of queues belonging to the account used to make the request | | [`twilio_voice_list_usage_record`](#twilio_voice_list_usage_record) | Retrieve a list of usage-records belonging to the account used to make the request | | [`twilio_voice_update_call`](#twilio_voice_update_call) | Initiates a call redirect or terminates a call | | [`twilio_voice_update_call_recording`](#twilio_voice_update_call_recording) | Changes the status of the recording to paused, stopped, or in-progress. Note: Pass `Twilio.CURRENT` instead of recording sid to reference current active recording. | | [`twilio_voice_update_conference`](#twilio_voice_update_conference) | POST /Conferences/\{Sid}.json | | [`twilio_voice_update_conference_recording`](#twilio_voice_update_conference_recording) | Changes the status of the recording to paused, stopped, or in-progress. Note: To use `Twilio.CURRENT`, pass it as recording sid. | | [`twilio_voice_update_member`](#twilio_voice_update_member) | Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL | | [`twilio_voice_update_participant`](#twilio_voice_update_participant) | Update the properties of the participant | | [`twilio_voice_update_payments`](#twilio_voice_update_payments) | update an instance of payments with different phases of payment flows. | | [`twilio_voice_update_queue`](#twilio_voice_update_queue) | Update the queue with the new parameters | | [`twilio_voice_update_realtime_transcription`](#twilio_voice_update_realtime_transcription) | Stop a Transcription using either the SID of the Transcription resource or the `name` used when creating the resource | | [`twilio_voice_update_siprec`](#twilio_voice_update_siprec) | Stop a Siprec using either the SID of the Siprec resource or the `name` used when creating the resource | | [`twilio_voice_update_stream`](#twilio_voice_update_stream) | Stop a Stream using either the SID of the Stream resource or the `name` used when creating the resource | *** ## twilio\_voice\_create\_call Create a new outgoing call to phones, SIP-enabled endpoints or Twilio Client connections **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ApplicationSid` | string | No | — | The SID of the Application resource that will handle the call, if the call will be handled by an application. | | `AsyncAmd` | string | No | — | Select whether to perform answering machine detection in the background. Default, blocks the execution of the call until Answering Machine Detection is completed. Can be: `true` or `false`. | | `AsyncAmdStatusCallback` | string | No | — | The URL that we should call using the `async_amd_status_callback_method` to notify customer application whether the call was answered by human, machine or fax. | | `AsyncAmdStatusCallbackMethod` | string | No | — | The HTTP method we should use when calling the `async_amd_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. | | `Byoc` | string | No | — | The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that `byoc` is only meaningful when `to` is a phone number; it will otherwise be ignored. (Beta) | | `CallerId` | string | No | — | The phone number, SIP address, or Client identifier that made this call. Phone numbers are in [E.164 format](https://wwnw.twilio.com/docs/glossary/what-e164) (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. | | `CallReason` | string | No | — | The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta) | | `CallToken` | string | No | — | A token string needed to invoke a forwarded call. A call\_token is generated when an incoming call is received on a Twilio number. Pass an incoming call's call\_token value to a forwarded call via the call\_token parameter when creating a new call. A forwarded call should bear the same CallerID of the original incoming call. | | `ClientNotificationUrl` | string | No | — | The URL that we should use to deliver `push call notification`. | | `FallbackMethod` | string | No | — | The HTTP method that we should use to request the `fallback_url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored. | | `FallbackUrl` | string | No | — | The URL that we call using the `fallback_method` if an error occurs when requesting or executing the TwiML at `url`. If an `application_sid` parameter is present, this parameter is ignored. | | `From` | string | Yes | — | The phone number or client identifier to use as the caller id. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `From` must also be a phone number. | | `MachineDetection` | string | No | — | Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine. If `send_digits` is provided, this parameter is ignored. For more information, see [Answering Machine Detection](https://www.twilio.com/docs/voice/answering-machine-detection). | | `MachineDetectionSilenceTimeout` | integer | No | — | The number of milliseconds of initial silence after which an `unknown` AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000. | | `MachineDetectionSpeechEndThreshold` | integer | No | — | The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200. | | `MachineDetectionSpeechThreshold` | integer | No | — | The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400. | | `MachineDetectionTimeout` | integer | No | — | The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds. | | `Method` | string | No | — | The HTTP method we should use when calling the `url` parameter's value. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored. | | `Record` | boolean | No | — | Whether to record the call. Can be `true` to record the phone call, or `false` to not. The default is `false`. The `recording_url` is sent to the `status_callback` URL. | | `RecordingChannels` | string | No | — | The number of channels in the final recording. Can be: `mono` or `dual`. The default is `mono`. `mono` records both legs of the call in a single channel of the recording file. `dual` records each leg to a separate channel of the recording file. The first channel of a dual-channel recording contains the parent call and the second channel contains the child call. | | `RecordingStatusCallback` | string | No | — | The URL that we call when the recording is available to be accessed. | | `RecordingStatusCallbackEvent` | string\[] | No | — | The recording status events that will trigger calls to the URL specified in `recording_status_callback`. Can be: `in-progress`, `completed` and `absent`. Defaults to `completed`. Separate multiple values with a space. | | `RecordingStatusCallbackMethod` | string | No | — | The HTTP method we should use when calling the `recording_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. | | `RecordingTrack` | string | No | — | The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is generated from Twilio. `both` records the audio that is received and generated by Twilio. | | `SendDigits` | string | No | — | The string of keys to dial after connecting to the number, with a maximum length of 32 digits. Valid digits in the string include any digit (`0`-`9`), '`A`', '`B`', '`C`', '`D`', '`#`', and '`*`'. You can also use '`w`' to insert a half-second pause and '`W`' to insert a one-second pause. For example, to pause for one second after connecting and then dial extension 1234 followed by the # key, set this parameter to `W1234#`. Be sure to URL-encode this string because the '`#`' character has special meaning in a URL. If both `SendDigits` and `MachineDetection` parameters are provided, then `MachineDetection` will be ignored. | | `SipAuthPassword` | string | No | — | The password required to authenticate the user account specified in `sip_auth_username`. | | `SipAuthUsername` | string | No | — | The username used to authenticate the caller making a SIP call. | | `StatusCallback` | string | No | — | The URL we should call using the `status_callback_method` to send status information to your application. If no `status_callback_event` is specified, we will send the `completed` status. If an `application_sid` parameter is present, this parameter is ignored. URLs must contain a valid hostname (underscores are not permitted). | | `StatusCallbackEvent` | string\[] | No | — | The call progress events that we will send to the `status_callback` URL. Can be: `initiated`, `ringing`, `answered`, and `completed`. If no event is specified, we send the `completed` status. If you want to receive multiple events, specify each one in a separate `status_callback_event` parameter. See the code sample for [monitoring call progress](https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent\&code-sdk-version=json). If an `application_sid` is present, this parameter is ignored. | | `StatusCallbackMethod` | string | No | — | The HTTP method we should use when calling the `status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored. | | `TimeLimit` | integer | No | — | The maximum duration of the call in seconds. Constraints depend on account and configuration. | | `Timeout` | integer | No | — | The integer number of seconds that we should allow the phone to ring before assuming there is no answer. The default is `60` seconds and the maximum is `600` seconds. For some call flows, we will add a 5-second buffer to the timeout value you provide. For this reason, a timeout value of 10 seconds could result in an actual timeout closer to 15 seconds. You can set this to a short time, such as `15` seconds, to hang up before reaching an answering machine or voicemail. | | `To` | string | Yes | — | The phone number, SIP address, or client identifier to call. | | `Trim` | string | No | — | Whether to trim any leading and trailing silence from the recording. Can be: `trim-silence` or `do-not-trim` and the default is `trim-silence`. | | `Twiml` | string | No | — | TwiML instructions for the call Twilio will use without fetching Twiml from url parameter. If both `twiml` and `url` are provided then `twiml` parameter will be ignored. Max 4000 characters. | | `Url` | string | No | — | The absolute URL that returns the TwiML instructions for the call. We will call this URL using the `method` when the call connects. For more information, see the [Url Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](https://www.twilio.com/docs/voice/make-calls). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ApplicationSid": { "type": "string", "description": "The SID of the Application resource that will handle the call, if the call will be handled by an application." }, "AsyncAmd": { "type": "string", "description": "Select whether to perform answering machine detection in the background. Default, blocks the execution of the call until Answering Machine Detection is completed. Can be: `true` or `false`." }, "AsyncAmdStatusCallback": { "type": "string", "description": "The URL that we should call using the `async_amd_status_callback_method` to notify customer application whether the call was answered by human, machine or fax." }, "AsyncAmdStatusCallbackMethod": { "type": "string", "description": "The HTTP method we should use when calling the `async_amd_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`.", "enum": [ "GET", "POST" ] }, "Byoc": { "type": "string", "description": "The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that `byoc` is only meaningful when `to` is a phone number; it will otherwise be ignored. (Beta)" }, "CallerId": { "type": "string", "description": "The phone number, SIP address, or Client identifier that made this call. Phone numbers are in [E.164 format](https://wwnw.twilio.com/docs/glossary/what-e164) (e.g., +16175551212). SIP addresses are formatted as `name@company.com`." }, "CallReason": { "type": "string", "description": "The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta)" }, "CallToken": { "type": "string", "description": "A token string needed to invoke a forwarded call. A call_token is generated when an incoming call is received on a Twilio number. Pass an incoming call's call_token value to a forwarded call via the call_token parameter when creating a new call. A forwarded call should bear the same CallerID of the original incoming call." }, "ClientNotificationUrl": { "type": "string", "description": "The URL that we should use to deliver `push call notification`." }, "FallbackMethod": { "type": "string", "description": "The HTTP method that we should use to request the `fallback_url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", "enum": [ "GET", "POST" ] }, "FallbackUrl": { "type": "string", "description": "The URL that we call using the `fallback_method` if an error occurs when requesting or executing the TwiML at `url`. If an `application_sid` parameter is present, this parameter is ignored." }, "From": { "type": "string", "description": "The phone number or client identifier to use as the caller id. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `From` must also be a phone number." }, "MachineDetection": { "type": "string", "description": "Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine. If `send_digits` is provided, this parameter is ignored. For more information, see [Answering Machine Detection](https://www.twilio.com/docs/voice/answering-machine-detection)." }, "MachineDetectionSilenceTimeout": { "type": "integer", "description": "The number of milliseconds of initial silence after which an `unknown` AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000." }, "MachineDetectionSpeechEndThreshold": { "type": "integer", "description": "The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200." }, "MachineDetectionSpeechThreshold": { "type": "integer", "description": "The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400." }, "MachineDetectionTimeout": { "type": "integer", "description": "The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds." }, "Method": { "type": "string", "description": "The HTTP method we should use when calling the `url` parameter's value. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", "enum": [ "GET", "POST" ] }, "Record": { "type": "boolean", "description": "Whether to record the call. Can be `true` to record the phone call, or `false` to not. The default is `false`. The `recording_url` is sent to the `status_callback` URL." }, "RecordingChannels": { "type": "string", "description": "The number of channels in the final recording. Can be: `mono` or `dual`. The default is `mono`. `mono` records both legs of the call in a single channel of the recording file. `dual` records each leg to a separate channel of the recording file. The first channel of a dual-channel recording contains the parent call and the second channel contains the child call." }, "RecordingStatusCallback": { "type": "string", "description": "The URL that we call when the recording is available to be accessed." }, "RecordingStatusCallbackEvent": { "type": "array", "items": { "type": "string" }, "description": "The recording status events that will trigger calls to the URL specified in `recording_status_callback`. Can be: `in-progress`, `completed` and `absent`. Defaults to `completed`. Separate multiple values with a space." }, "RecordingStatusCallbackMethod": { "type": "string", "description": "The HTTP method we should use when calling the `recording_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`.", "enum": [ "GET", "POST" ] }, "RecordingTrack": { "type": "string", "description": "The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is generated from Twilio. `both` records the audio that is received and generated by Twilio." }, "SendDigits": { "type": "string", "description": "The string of keys to dial after connecting to the number, with a maximum length of 32 digits. Valid digits in the string include any digit (`0`-`9`), '`A`', '`B`', '`C`', '`D`', '`#`', and '`*`'. You can also use '`w`' to insert a half-second pause and '`W`' to insert a one-second pause. For example, to pause for one second after connecting and then dial extension 1234 followed by the # key, set this parameter to `W1234#`. Be sure to URL-encode this string because the '`#`' character has special meaning in a URL. If both `SendDigits` and `MachineDetection` parameters are provided, then `MachineDetection` will be ignored." }, "SipAuthPassword": { "type": "string", "description": "The password required to authenticate the user account specified in `sip_auth_username`." }, "SipAuthUsername": { "type": "string", "description": "The username used to authenticate the caller making a SIP call." }, "StatusCallback": { "type": "string", "description": "The URL we should call using the `status_callback_method` to send status information to your application. If no `status_callback_event` is specified, we will send the `completed` status. If an `application_sid` parameter is present, this parameter is ignored. URLs must contain a valid hostname (underscores are not permitted)." }, "StatusCallbackEvent": { "type": "array", "items": { "type": "string" }, "description": "The call progress events that we will send to the `status_callback` URL. Can be: `initiated`, `ringing`, `answered`, and `completed`. If no event is specified, we send the `completed` status. If you want to receive multiple events, specify each one in a separate `status_callback_event` parameter. See the code sample for [monitoring call progress](https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent&code-sdk-version=json). If an `application_sid` is present, this parameter is ignored." }, "StatusCallbackMethod": { "type": "string", "description": "The HTTP method we should use when calling the `status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", "enum": [ "GET", "POST" ] }, "TimeLimit": { "type": "integer", "description": "The maximum duration of the call in seconds. Constraints depend on account and configuration." }, "Timeout": { "type": "integer", "description": "The integer number of seconds that we should allow the phone to ring before assuming there is no answer. The default is `60` seconds and the maximum is `600` seconds. For some call flows, we will add a 5-second buffer to the timeout value you provide. For this reason, a timeout value of 10 seconds could result in an actual timeout closer to 15 seconds. You can set this to a short time, such as `15` seconds, to hang up before reaching an answering machine or voicemail." }, "To": { "type": "string", "description": "The phone number, SIP address, or client identifier to call." }, "Trim": { "type": "string", "description": "Whether to trim any leading and trailing silence from the recording. Can be: `trim-silence` or `do-not-trim` and the default is `trim-silence`." }, "Twiml": { "type": "string", "description": "TwiML instructions for the call Twilio will use without fetching Twiml from url parameter. If both `twiml` and `url` are provided then `twiml` parameter will be ignored. Max 4000 characters." }, "Url": { "type": "string", "description": "The absolute URL that returns the TwiML instructions for the call. We will call this URL using the `method` when the call connects. For more information, see the [Url Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](https://www.twilio.com/docs/voice/make-calls)." } }, "required": [ "PCID", "From", "To" ] } ``` *** ## twilio\_voice\_create\_call\_recording Create a recording for the call **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `CallSid` | string | Yes | — | The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) to associate the resource with. | | `RecordingChannels` | string | No | — | The number of channels used in the recording. Can be: `mono` or `dual` and the default is `mono`. `mono` records all parties of the call into one channel. `dual` records each party of a 2-party call into separate channels. | | `RecordingStatusCallback` | string | No | — | The URL we should call using the `recording_status_callback_method` on each recording event specified in `recording_status_callback_event`. For more information, see [RecordingStatusCallback parameters](https://www.twilio.com/docs/voice/api/recording#recordingstatuscallback). | | `RecordingStatusCallbackEvent` | string\[] | No | — | The recording status events on which we should call the `recording_status_callback` URL. Can be: `in-progress`, `completed` and `absent` and the default is `completed`. Separate multiple event values with a space. | | `RecordingStatusCallbackMethod` | string | No | — | The HTTP method we should use to call `recording_status_callback`. Can be: `GET` or `POST` and the default is `POST`. | | `RecordingTrack` | string | No | — | The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is generated from Twilio. `both` records the audio that is received and generated by Twilio. | | `Trim` | string | No | — | Whether to trim any leading and trailing silence in the recording. Can be: `trim-silence` or `do-not-trim` and the default is `do-not-trim`. `trim-silence` trims the silence from the beginning and end of the recording and `do-not-trim` does not. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) to associate the resource with." }, "RecordingChannels": { "type": "string", "description": "The number of channels used in the recording. Can be: `mono` or `dual` and the default is `mono`. `mono` records all parties of the call into one channel. `dual` records each party of a 2-party call into separate channels." }, "RecordingStatusCallback": { "type": "string", "description": "The URL we should call using the `recording_status_callback_method` on each recording event specified in `recording_status_callback_event`. For more information, see [RecordingStatusCallback parameters](https://www.twilio.com/docs/voice/api/recording#recordingstatuscallback)." }, "RecordingStatusCallbackEvent": { "type": "array", "items": { "type": "string" }, "description": "The recording status events on which we should call the `recording_status_callback` URL. Can be: `in-progress`, `completed` and `absent` and the default is `completed`. Separate multiple event values with a space." }, "RecordingStatusCallbackMethod": { "type": "string", "description": "The HTTP method we should use to call `recording_status_callback`. Can be: `GET` or `POST` and the default is `POST`.", "enum": [ "GET", "POST" ] }, "RecordingTrack": { "type": "string", "description": "The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is generated from Twilio. `both` records the audio that is received and generated by Twilio." }, "Trim": { "type": "string", "description": "Whether to trim any leading and trailing silence in the recording. Can be: `trim-silence` or `do-not-trim` and the default is `do-not-trim`. `trim-silence` trims the silence from the beginning and end of the recording and `do-not-trim` does not." } }, "required": [ "PCID", "CallSid" ] } ``` *** ## twilio\_voice\_create\_message\_feedback Create Message Feedback to confirm a tracked user action was performed by the recipient of the associated Message **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `MessageSid` | string | Yes | — | The SID of the Message resource for which to create MessageFeedback. | | `Outcome` | string | No | — | Reported outcome indicating whether there is confirmation that the Message recipient performed a tracked user action. Can be: `unconfirmed` or `confirmed`. For more details see [How to Optimize Message Deliverability with Message Feedback](https://www.twilio.com/docs/messaging/guides/send-message-feedback-to-twilio). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "MessageSid": { "type": "string", "description": "The SID of the Message resource for which to create MessageFeedback." }, "Outcome": { "type": "string", "description": "Reported outcome indicating whether there is confirmation that the Message recipient performed a tracked user action. Can be: `unconfirmed` or `confirmed`. For more details see [How to Optimize Message Deliverability with Message Feedback](https://www.twilio.com/docs/messaging/guides/send-message-feedback-to-twilio).", "enum": [ "confirmed", "unconfirmed" ] } }, "required": [ "PCID", "MessageSid" ] } ``` *** ## twilio\_voice\_create\_participant POST /Conferences/\{ConferenceSid}/Participants.json **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ConferenceSid` | string | Yes | — | The SID of the participant's conference. | | `AmdStatusCallback` | string | No | — | The URL that we should call using the `amd_status_callback_method` to notify customer application whether the call was answered by human, machine or fax. | | `AmdStatusCallbackMethod` | string | No | — | The HTTP method we should use when calling the `amd_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. | | `Beep` | string | No | — | Whether to play a notification beep to the conference when the participant joins. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`. | | `Byoc` | string | No | — | The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that `byoc` is only meaningful when `to` is a phone number; it will otherwise be ignored. (Beta) | | `CallerDisplayName` | string | No | — | The name that populates the display name in the From header. Must be between 2 and 255 characters. Only applicable for calls to sip address. | | `CallerId` | string | No | — | The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). Client identifiers are formatted `client:name`. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `callerId` must also be a phone number. If `to` is sip address, this value of `callerId` should be a username portion to be used to populate the From header that is passed to the SIP endpoint. | | `CallReason` | string | No | — | The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta) | | `CallSidToCoach` | string | No | — | The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`. | | `CallToken` | string | No | — | A token string needed to invoke a forwarded call. A call\_token is generated when an incoming call is received on a Twilio number. Pass an incoming call's call\_token value to a forwarded call via the call\_token parameter when creating a new call. A forwarded call should bear the same CallerID of the original incoming call. | | `ClientNotificationUrl` | string | No | — | The URL that we should use to deliver `push call notification`. | | `Coaching` | boolean | No | — | Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined. | | `ConferenceRecord` | string | No | — | Whether to record the conference the participant is joining. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`. | | `ConferenceRecordingStatusCallback` | string | No | — | The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available. | | `ConferenceRecordingStatusCallbackEvent` | string\[] | No | — | The conference recording state changes that generate a call to `conference_recording_status_callback`. Can be: `in-progress`, `completed`, `failed`, and `absent`. Separate multiple values with a space, ex: `'in-progress completed failed'` | | `ConferenceRecordingStatusCallbackMethod` | string | No | — | The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`. | | `ConferenceStatusCallback` | string | No | — | The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored. | | `ConferenceStatusCallbackEvent` | string\[] | No | — | The conference state changes that should generate a call to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `modify`, `speaker`, and `announcement`. Separate multiple values with a space. Defaults to `start end`. | | `ConferenceStatusCallbackMethod` | string | No | — | The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`. | | `ConferenceTrim` | string | No | — | Whether to trim leading and trailing silence from the conference recording. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`. | | `EarlyMedia` | boolean | No | — | Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. Can be: `true` or `false` and defaults to `true`. | | `EndConferenceOnExit` | boolean | No | — | Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`. | | `From` | string | Yes | — | The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). Client identifiers are formatted `client:name`. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `from` must also be a phone number. If `to` is sip address, this value of `from` should be a username portion to be used to populate the P-Asserted-Identity header that is passed to the SIP endpoint. | | `JitterBufferSize` | string | No | — | Jitter buffer size for the connecting participant. Twilio will use this setting to apply Jitter Buffer before participant's audio is mixed into the conference. Can be: `off`, `small`, `medium`, and `large`. Default to `large`. | | `Label` | string | No | — | A label for this participant. If one is supplied, it may subsequently be used to fetch, update or delete the participant. | | `MachineDetection` | string | No | — | Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine. For more information, see [Answering Machine Detection](https://www.twilio.com/docs/voice/answering-machine-detection). | | `MachineDetectionSilenceTimeout` | integer | No | — | The number of milliseconds of initial silence after which an `unknown` AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000. | | `MachineDetectionSpeechEndThreshold` | integer | No | — | The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200. | | `MachineDetectionSpeechThreshold` | integer | No | — | The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400. | | `MachineDetectionTimeout` | integer | No | — | The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds. | | `MaxParticipants` | integer | No | — | The maximum number of participants in the conference. Can be a positive integer from `2` to `250`. The default value is `250`. | | `Muted` | boolean | No | — | Whether the agent is muted in the conference. Can be `true` or `false` and the default is `false`. | | `Record` | boolean | No | — | Whether to record the participant and their conferences, including the time between conferences. Can be `true` or `false` and the default is `false`. | | `RecordingChannels` | string | No | — | The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`. | | `RecordingStatusCallback` | string | No | — | The URL that we should call using the `recording_status_callback_method` when the recording status changes. | | `RecordingStatusCallbackEvent` | string\[] | No | — | The recording state changes that should generate a call to `recording_status_callback`. Can be: `started`, `in-progress`, `paused`, `resumed`, `stopped`, `completed`, `failed`, and `absent`. Separate multiple values with a space, ex: `'in-progress completed failed'`. | | `RecordingStatusCallbackMethod` | string | No | — | The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`. | | `RecordingTrack` | string | No | — | The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is sent from Twilio. `both` records the audio that is received and sent by Twilio. | | `Region` | string | No | — | The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `us2`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`. | | `SipAuthPassword` | string | No | — | The SIP password for authentication. | | `SipAuthUsername` | string | No | — | The SIP username used for authentication. | | `StartConferenceOnEnter` | boolean | No | — | Whether to start the conference when the participant joins, if it has not already started. Can be: `true` or `false` and the default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference. | | `StatusCallback` | string | No | — | The URL we should call using the `status_callback_method` to send status information to your application. | | `StatusCallbackEvent` | string\[] | No | — | The conference state changes that should generate a call to `status_callback`. Can be: `initiated`, `ringing`, `answered`, and `completed`. Separate multiple values with a space. The default value is `completed`. | | `StatusCallbackMethod` | string | No | — | The HTTP method we should use to call `status_callback`. Can be: `GET` and `POST` and defaults to `POST`. | | `TimeLimit` | integer | No | — | The maximum duration of the call in seconds. Constraints depend on account and configuration. | | `Timeout` | integer | No | — | The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between `5` and `600`, inclusive. The default value is `60`. We always add a 5-second timeout buffer to outgoing calls, so value of 10 would result in an actual timeout that was closer to 15 seconds. | | `To` | string | Yes | — | The phone number, SIP address, Client, TwiML App identifier that received this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `sip:name@company.com`. Client identifiers are formatted `client:name`. TwiML App identifiers are formatted `app:<APP_SID>`. [Custom parameters](https://www.twilio.com/docs/voice/api/conference-participant-resource#custom-parameters) may also be specified. | | `Trim` | string | No | — | Whether to trim any leading and trailing silence from the participant recording. Can be: `trim-silence` or `do-not-trim` and the default is `trim-silence`. | | `WaitMethod` | string | No | — | The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file. | | `WaitUrl` | string | No | — | The URL that Twilio calls using the `wait_method` before the conference has started. The URL may return an MP3 file, a WAV file, or a TwiML document. The default value is the URL of our standard hold music. If you do not want anything to play while waiting for the conference to start, specify an empty string by setting `wait_url` to `''`. For more details on the allowable verbs within the `waitUrl`, see the `waitUrl` attribute in the [\ TwiML instruction](https://www.twilio.com/docs/voice/twiml/conference#attributes-waiturl). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ConferenceSid": { "type": "string", "description": "The SID of the participant's conference." }, "AmdStatusCallback": { "type": "string", "description": "The URL that we should call using the `amd_status_callback_method` to notify customer application whether the call was answered by human, machine or fax." }, "AmdStatusCallbackMethod": { "type": "string", "description": "The HTTP method we should use when calling the `amd_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`.", "enum": [ "GET", "POST" ] }, "Beep": { "type": "string", "description": "Whether to play a notification beep to the conference when the participant joins. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`." }, "Byoc": { "type": "string", "description": "The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that `byoc` is only meaningful when `to` is a phone number; it will otherwise be ignored. (Beta)" }, "CallerDisplayName": { "type": "string", "description": "The name that populates the display name in the From header. Must be between 2 and 255 characters. Only applicable for calls to sip address." }, "CallerId": { "type": "string", "description": "The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). Client identifiers are formatted `client:name`. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `callerId` must also be a phone number. If `to` is sip address, this value of `callerId` should be a username portion to be used to populate the From header that is passed to the SIP endpoint." }, "CallReason": { "type": "string", "description": "The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta)" }, "CallSidToCoach": { "type": "string", "description": "The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`." }, "CallToken": { "type": "string", "description": "A token string needed to invoke a forwarded call. A call_token is generated when an incoming call is received on a Twilio number. Pass an incoming call's call_token value to a forwarded call via the call_token parameter when creating a new call. A forwarded call should bear the same CallerID of the original incoming call." }, "ClientNotificationUrl": { "type": "string", "description": "The URL that we should use to deliver `push call notification`." }, "Coaching": { "type": "boolean", "description": "Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined." }, "ConferenceRecord": { "type": "string", "description": "Whether to record the conference the participant is joining. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`." }, "ConferenceRecordingStatusCallback": { "type": "string", "description": "The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available." }, "ConferenceRecordingStatusCallbackEvent": { "type": "array", "items": { "type": "string" }, "description": "The conference recording state changes that generate a call to `conference_recording_status_callback`. Can be: `in-progress`, `completed`, `failed`, and `absent`. Separate multiple values with a space, ex: `'in-progress completed failed'`" }, "ConferenceRecordingStatusCallbackMethod": { "type": "string", "description": "The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", "enum": [ "GET", "POST" ] }, "ConferenceStatusCallback": { "type": "string", "description": "The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored." }, "ConferenceStatusCallbackEvent": { "type": "array", "items": { "type": "string" }, "description": "The conference state changes that should generate a call to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `modify`, `speaker`, and `announcement`. Separate multiple values with a space. Defaults to `start end`." }, "ConferenceStatusCallbackMethod": { "type": "string", "description": "The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", "enum": [ "GET", "POST" ] }, "ConferenceTrim": { "type": "string", "description": "Whether to trim leading and trailing silence from the conference recording. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`." }, "EarlyMedia": { "type": "boolean", "description": "Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. Can be: `true` or `false` and defaults to `true`." }, "EndConferenceOnExit": { "type": "boolean", "description": "Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`." }, "From": { "type": "string", "description": "The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). Client identifiers are formatted `client:name`. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `from` must also be a phone number. If `to` is sip address, this value of `from` should be a username portion to be used to populate the P-Asserted-Identity header that is passed to the SIP endpoint." }, "JitterBufferSize": { "type": "string", "description": "Jitter buffer size for the connecting participant. Twilio will use this setting to apply Jitter Buffer before participant's audio is mixed into the conference. Can be: `off`, `small`, `medium`, and `large`. Default to `large`." }, "Label": { "type": "string", "description": "A label for this participant. If one is supplied, it may subsequently be used to fetch, update or delete the participant." }, "MachineDetection": { "type": "string", "description": "Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine. For more information, see [Answering Machine Detection](https://www.twilio.com/docs/voice/answering-machine-detection)." }, "MachineDetectionSilenceTimeout": { "type": "integer", "description": "The number of milliseconds of initial silence after which an `unknown` AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000." }, "MachineDetectionSpeechEndThreshold": { "type": "integer", "description": "The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200." }, "MachineDetectionSpeechThreshold": { "type": "integer", "description": "The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400." }, "MachineDetectionTimeout": { "type": "integer", "description": "The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds." }, "MaxParticipants": { "type": "integer", "description": "The maximum number of participants in the conference. Can be a positive integer from `2` to `250`. The default value is `250`." }, "Muted": { "type": "boolean", "description": "Whether the agent is muted in the conference. Can be `true` or `false` and the default is `false`." }, "Record": { "type": "boolean", "description": "Whether to record the participant and their conferences, including the time between conferences. Can be `true` or `false` and the default is `false`." }, "RecordingChannels": { "type": "string", "description": "The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`." }, "RecordingStatusCallback": { "type": "string", "description": "The URL that we should call using the `recording_status_callback_method` when the recording status changes." }, "RecordingStatusCallbackEvent": { "type": "array", "items": { "type": "string" }, "description": "The recording state changes that should generate a call to `recording_status_callback`. Can be: `started`, `in-progress`, `paused`, `resumed`, `stopped`, `completed`, `failed`, and `absent`. Separate multiple values with a space, ex: `'in-progress completed failed'`." }, "RecordingStatusCallbackMethod": { "type": "string", "description": "The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", "enum": [ "GET", "POST" ] }, "RecordingTrack": { "type": "string", "description": "The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is sent from Twilio. `both` records the audio that is received and sent by Twilio." }, "Region": { "type": "string", "description": "The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `us2`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`." }, "SipAuthPassword": { "type": "string", "description": "The SIP password for authentication." }, "SipAuthUsername": { "type": "string", "description": "The SIP username used for authentication." }, "StartConferenceOnEnter": { "type": "boolean", "description": "Whether to start the conference when the participant joins, if it has not already started. Can be: `true` or `false` and the default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference." }, "StatusCallback": { "type": "string", "description": "The URL we should call using the `status_callback_method` to send status information to your application." }, "StatusCallbackEvent": { "type": "array", "items": { "type": "string" }, "description": "The conference state changes that should generate a call to `status_callback`. Can be: `initiated`, `ringing`, `answered`, and `completed`. Separate multiple values with a space. The default value is `completed`." }, "StatusCallbackMethod": { "type": "string", "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` and `POST` and defaults to `POST`.", "enum": [ "GET", "POST" ] }, "TimeLimit": { "type": "integer", "description": "The maximum duration of the call in seconds. Constraints depend on account and configuration." }, "Timeout": { "type": "integer", "description": "The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between `5` and `600`, inclusive. The default value is `60`. We always add a 5-second timeout buffer to outgoing calls, so value of 10 would result in an actual timeout that was closer to 15 seconds." }, "To": { "type": "string", "description": "The phone number, SIP address, Client, TwiML App identifier that received this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `sip:name@company.com`. Client identifiers are formatted `client:name`. TwiML App identifiers are formatted `app:`. [Custom parameters](https://www.twilio.com/docs/voice/api/conference-participant-resource#custom-parameters) may also be specified." }, "Trim": { "type": "string", "description": "Whether to trim any leading and trailing silence from the participant recording. Can be: `trim-silence` or `do-not-trim` and the default is `trim-silence`." }, "WaitMethod": { "type": "string", "description": "The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.", "enum": [ "GET", "POST" ] }, "WaitUrl": { "type": "string", "description": "The URL that Twilio calls using the `wait_method` before the conference has started. The URL may return an MP3 file, a WAV file, or a TwiML document. The default value is the URL of our standard hold music. If you do not want anything to play while waiting for the conference to start, specify an empty string by setting `wait_url` to `''`. For more details on the allowable verbs within the `waitUrl`, see the `waitUrl` attribute in the [ TwiML instruction](https://www.twilio.com/docs/voice/twiml/conference#attributes-waiturl)." } }, "required": [ "PCID", "ConferenceSid", "From", "To" ] } ``` *** ## twilio\_voice\_create\_payments create an instance of payments. This will start a new payments session **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `CallSid` | string | Yes | — | The SID of the call that will create the resource. Call leg associated with this sid is expected to provide payment information thru DTMF. | | `BankAccountType` | string | No | — | Type of bank account if payment source is ACH. One of `consumer-checking`, `consumer-savings`, or `commercial-checking`. The default value is `consumer-checking`. | | `ChargeAmount` | number | No | — | A positive decimal value less than 1,000,000 to charge against the credit card or bank account. Default currency can be overwritten with `currency` field. Leave blank or set to 0 to tokenize. | | `Confirmation` | string | No | — | Whether to prompt the caller to confirm their payment information before submitting to the payment gateway. If `true`, the caller will hear the last 4 digits of their card or account number and must press 1 to confirm or 2 to cancel. Default is `false`. | | `Currency` | string | No | — | The currency of the `charge_amount`, formatted as ISO 4127 format. The default value is `USD` and all values allowed from the Pay Connector are accepted. | | `Description` | string | No | — | The description can be used to provide more details regarding the transaction. This information is submitted along with the payment details to the Payment Connector which are then posted on the transactions. | | `IdempotencyKey` | string | Yes | — | A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated. | | `Input` | string | No | — | A list of inputs that should be accepted. Currently only `dtmf` is supported. All digits captured during a pay session are redacted from the logs. | | `MinPostalCodeLength` | integer | No | — | A positive integer that is used to validate the length of the `PostalCode` inputted by the user. User must enter this many digits. | | `Parameter` | object | No | — | A single-level JSON object used to pass custom parameters to payment processors. (Required for ACH payments). The information that has to be included here depends on the \ Connector. [Read more](https://www.twilio.com/console/voice/pay-connectors). | | `PaymentConnector` | string | No | — | This is the unique name corresponding to the Pay Connector installed in the Twilio Add-ons. Learn more about [\ Connectors](https://www.twilio.com/console/voice/pay-connectors). The default value is `Default`. | | `PaymentMethod` | string | No | — | Type of payment being captured. One of `credit-card` or `ach-debit`. The default value is `credit-card`. | | `PostalCode` | boolean | No | — | Indicates whether the credit card postal code (zip code) is a required piece of payment information that must be provided by the caller. The default is `true`. | | `RequireMatchingInputs` | string | No | — | A comma-separated list of payment information fields that require the caller to enter the same value twice for confirmation. Supported values are `payment-card-number`, `expiration-date`, `security-code`, and `postal-code`. | | `SecurityCode` | boolean | No | — | Indicates whether the credit card security code is a required piece of payment information that must be provided by the caller. The default is `true`. | | `StatusCallback` | string | Yes | — | Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [expected StatusCallback values](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback) | | `Timeout` | integer | No | — | The number of seconds that \ should wait for the caller to press a digit between each subsequent digit, after the first one, before moving on to validate the digits captured. The default is `5`, maximum is `600`. | | `TokenType` | string | No | — | Indicates whether the payment method should be tokenized as a `one-time`, `reusable`, or `payment-method` token. The default value is `reusable`. Do not enter a charge amount when tokenizing. If a charge amount is entered, the payment method will be charged and not tokenized. | | `ValidCardTypes` | string | No | — | Credit card types separated by space that Pay should accept. The default value is `visa mastercard amex` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The SID of the call that will create the resource. Call leg associated with this sid is expected to provide payment information thru DTMF." }, "BankAccountType": { "type": "string", "description": "Type of bank account if payment source is ACH. One of `consumer-checking`, `consumer-savings`, or `commercial-checking`. The default value is `consumer-checking`.", "enum": [ "consumer-checking", "consumer-savings", "commercial-checking" ] }, "ChargeAmount": { "type": "number", "description": "A positive decimal value less than 1,000,000 to charge against the credit card or bank account. Default currency can be overwritten with `currency` field. Leave blank or set to 0 to tokenize." }, "Confirmation": { "type": "string", "description": "Whether to prompt the caller to confirm their payment information before submitting to the payment gateway. If `true`, the caller will hear the last 4 digits of their card or account number and must press 1 to confirm or 2 to cancel. Default is `false`.", "enum": [ "true", "false" ] }, "Currency": { "type": "string", "description": "The currency of the `charge_amount`, formatted as [ISO 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format. The default value is `USD` and all values allowed from the Pay Connector are accepted." }, "Description": { "type": "string", "description": "The description can be used to provide more details regarding the transaction. This information is submitted along with the payment details to the Payment Connector which are then posted on the transactions." }, "IdempotencyKey": { "type": "string", "description": "A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated." }, "Input": { "type": "string", "description": "A list of inputs that should be accepted. Currently only `dtmf` is supported. All digits captured during a pay session are redacted from the logs." }, "MinPostalCodeLength": { "type": "integer", "description": "A positive integer that is used to validate the length of the `PostalCode` inputted by the user. User must enter this many digits." }, "Parameter": { "description": "A single-level JSON object used to pass custom parameters to payment processors. (Required for ACH payments). The information that has to be included here depends on the Connector. [Read more](https://www.twilio.com/console/voice/pay-connectors)." }, "PaymentConnector": { "type": "string", "description": "This is the unique name corresponding to the Pay Connector installed in the Twilio Add-ons. Learn more about [ Connectors](https://www.twilio.com/console/voice/pay-connectors). The default value is `Default`." }, "PaymentMethod": { "type": "string", "description": "Type of payment being captured. One of `credit-card` or `ach-debit`. The default value is `credit-card`.", "enum": [ "credit-card", "ach-debit" ] }, "PostalCode": { "type": "boolean", "description": "Indicates whether the credit card postal code (zip code) is a required piece of payment information that must be provided by the caller. The default is `true`." }, "RequireMatchingInputs": { "type": "string", "description": "A comma-separated list of payment information fields that require the caller to enter the same value twice for confirmation. Supported values are `payment-card-number`, `expiration-date`, `security-code`, and `postal-code`." }, "SecurityCode": { "type": "boolean", "description": "Indicates whether the credit card security code is a required piece of payment information that must be provided by the caller. The default is `true`." }, "StatusCallback": { "type": "string", "description": "Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [expected StatusCallback values](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback)" }, "Timeout": { "type": "integer", "description": "The number of seconds that should wait for the caller to press a digit between each subsequent digit, after the first one, before moving on to validate the digits captured. The default is `5`, maximum is `600`." }, "TokenType": { "type": "string", "description": "Indicates whether the payment method should be tokenized as a `one-time`, `reusable`, or `payment-method` token. The default value is `reusable`. Do not enter a charge amount when tokenizing. If a charge amount is entered, the payment method will be charged and not tokenized.", "enum": [ "one-time", "reusable", "payment-method" ] }, "ValidCardTypes": { "type": "string", "description": "Credit card types separated by space that Pay should accept. The default value is `visa mastercard amex`" } }, "required": [ "PCID", "CallSid", "IdempotencyKey", "StatusCallback" ] } ``` *** ## twilio\_voice\_create\_queue Create a queue **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------- | | `FriendlyName` | string | Yes | — | A descriptive string that you created to describe this resource. It can be up to 64 characters long. | | `MaxSize` | integer | No | — | The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "FriendlyName": { "type": "string", "description": "A descriptive string that you created to describe this resource. It can be up to 64 characters long." }, "MaxSize": { "type": "integer", "description": "The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000." } }, "required": [ "PCID", "FriendlyName" ] } ``` *** ## twilio\_voice\_create\_realtime\_transcription Create a Transcription **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `CallSid` | string | Yes | — | The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Transcription resource is associated with. | | `ConfigurationId` | string | No | — | The ID of the RealTimeTranscription Configuration for configuring all the non-default behaviors in one go. | | `ConversationConfiguration` | string | No | — | The ID of the Conversations Configuration for customizing conversation behavior in Intelligence Service | | `ConversationId` | string | No | — | The ID of the Conversation for associating this Transcription with an existing Conversation in Intelligence Service | | `EnableAutomaticPunctuation` | boolean | No | — | The provider will add punctuation to recognition result | | `EnableProviderData` | boolean | No | — | Whether the callback includes raw provider data. | | `Hints` | string | No | — | A Phrase contains words and phrase "hints" so that the speech recognition engine is more likely to recognize them. | | `InboundTrackLabel` | string | No | — | Friendly name given to the Inbound Track | | `IntelligenceService` | string | No | — | The SID or unique name of the [Intelligence Service](https://www.twilio.com/docs/conversational-intelligence/api/service-resource) for persisting transcripts and running post-call Language Operators | | `LanguageCode` | string | No | — | Language code used by the transcription engine, specified in [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) format | | `Name` | string | No | — | The user-specified name of this Transcription, if one was given when the Transcription was created. This may be used to stop the Transcription. | | `OutboundTrackLabel` | string | No | — | Friendly name given to the Outbound Track | | `PartialResults` | boolean | No | — | Indicates if partial results are going to be sent to the customer | | `ProfanityFilter` | boolean | No | — | indicates if the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks | | `SpeechModel` | string | No | — | Recognition model used by the transcription engine, among those supported by the provider | | `StatusCallbackMethod` | string | No | — | The http method for the status\_callback (one of GET, POST). | | `StatusCallbackUrl` | string | No | — | Absolute URL of the status callback. | | `Track` | string | No | — | One of `inbound_track`, `outbound_track`, `both_tracks`. | | `TranscriptionEngine` | string | No | — | Definition of the transcription engine to be used, among those supported by Twilio | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Transcription resource is associated with." }, "ConfigurationId": { "type": "string", "description": "The ID of the RealTimeTranscription Configuration for configuring all the non-default behaviors in one go." }, "ConversationConfiguration": { "type": "string", "description": "The ID of the Conversations Configuration for customizing conversation behavior in Intelligence Service" }, "ConversationId": { "type": "string", "description": "The ID of the Conversation for associating this Transcription with an existing Conversation in Intelligence Service" }, "EnableAutomaticPunctuation": { "type": "boolean", "description": "The provider will add punctuation to recognition result" }, "EnableProviderData": { "type": "boolean", "description": "Whether the callback includes raw provider data." }, "Hints": { "type": "string", "description": "A Phrase contains words and phrase \"hints\" so that the speech recognition engine is more likely to recognize them." }, "InboundTrackLabel": { "type": "string", "description": "Friendly name given to the Inbound Track" }, "IntelligenceService": { "type": "string", "description": "The SID or unique name of the [Intelligence Service](https://www.twilio.com/docs/conversational-intelligence/api/service-resource) for persisting transcripts and running post-call Language Operators" }, "LanguageCode": { "type": "string", "description": "Language code used by the transcription engine, specified in [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) format" }, "Name": { "type": "string", "description": "The user-specified name of this Transcription, if one was given when the Transcription was created. This may be used to stop the Transcription." }, "OutboundTrackLabel": { "type": "string", "description": "Friendly name given to the Outbound Track" }, "PartialResults": { "type": "boolean", "description": "Indicates if partial results are going to be sent to the customer" }, "ProfanityFilter": { "type": "boolean", "description": "indicates if the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks" }, "SpeechModel": { "type": "string", "description": "Recognition model used by the transcription engine, among those supported by the provider" }, "StatusCallbackMethod": { "type": "string", "description": "The http method for the status_callback (one of GET, POST).", "enum": [ "GET", "POST" ] }, "StatusCallbackUrl": { "type": "string", "description": "Absolute URL of the status callback." }, "Track": { "type": "string", "description": "One of `inbound_track`, `outbound_track`, `both_tracks`.", "enum": [ "inbound_track", "outbound_track", "both_tracks" ] }, "TranscriptionEngine": { "type": "string", "description": "Definition of the transcription engine to be used, among those supported by Twilio" } }, "required": [ "PCID", "CallSid" ] } ``` *** ## twilio\_voice\_create\_siprec Create a Siprec **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------- | | `CallSid` | string | Yes | — | The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Siprec resource is associated with. | | `ConnectorName` | string | No | — | Unique name used when configuring the connector via Marketplace Add-on. | | `Name` | string | No | — | The user-specified name of this Siprec, if one was given when the Siprec was created. This may be used to stop the Siprec. | | `Parameter1.Name` | string | No | — | Parameter name | | `Parameter1.Value` | string | No | — | Parameter value | | `Parameter10.Name` | string | No | — | Parameter name | | `Parameter10.Value` | string | No | — | Parameter value | | `Parameter11.Name` | string | No | — | Parameter name | | `Parameter11.Value` | string | No | — | Parameter value | | `Parameter12.Name` | string | No | — | Parameter name | | `Parameter12.Value` | string | No | — | Parameter value | | `Parameter13.Name` | string | No | — | Parameter name | | `Parameter13.Value` | string | No | — | Parameter value | | `Parameter14.Name` | string | No | — | Parameter name | | `Parameter14.Value` | string | No | — | Parameter value | | `Parameter15.Name` | string | No | — | Parameter name | | `Parameter15.Value` | string | No | — | Parameter value | | `Parameter16.Name` | string | No | — | Parameter name | | `Parameter16.Value` | string | No | — | Parameter value | | `Parameter17.Name` | string | No | — | Parameter name | | `Parameter17.Value` | string | No | — | Parameter value | | `Parameter18.Name` | string | No | — | Parameter name | | `Parameter18.Value` | string | No | — | Parameter value | | `Parameter19.Name` | string | No | — | Parameter name | | `Parameter19.Value` | string | No | — | Parameter value | | `Parameter2.Name` | string | No | — | Parameter name | | `Parameter2.Value` | string | No | — | Parameter value | | `Parameter20.Name` | string | No | — | Parameter name | | `Parameter20.Value` | string | No | — | Parameter value | | `Parameter21.Name` | string | No | — | Parameter name | | `Parameter21.Value` | string | No | — | Parameter value | | `Parameter22.Name` | string | No | — | Parameter name | | `Parameter22.Value` | string | No | — | Parameter value | | `Parameter23.Name` | string | No | — | Parameter name | | `Parameter23.Value` | string | No | — | Parameter value | | `Parameter24.Name` | string | No | — | Parameter name | | `Parameter24.Value` | string | No | — | Parameter value | | `Parameter25.Name` | string | No | — | Parameter name | | `Parameter25.Value` | string | No | — | Parameter value | | `Parameter26.Name` | string | No | — | Parameter name | | `Parameter26.Value` | string | No | — | Parameter value | | `Parameter27.Name` | string | No | — | Parameter name | | `Parameter27.Value` | string | No | — | Parameter value | | `Parameter28.Name` | string | No | — | Parameter name | | `Parameter28.Value` | string | No | — | Parameter value | | `Parameter29.Name` | string | No | — | Parameter name | | `Parameter29.Value` | string | No | — | Parameter value | | `Parameter3.Name` | string | No | — | Parameter name | | `Parameter3.Value` | string | No | — | Parameter value | | `Parameter30.Name` | string | No | — | Parameter name | | `Parameter30.Value` | string | No | — | Parameter value | | `Parameter31.Name` | string | No | — | Parameter name | | `Parameter31.Value` | string | No | — | Parameter value | | `Parameter32.Name` | string | No | — | Parameter name | | `Parameter32.Value` | string | No | — | Parameter value | | `Parameter33.Name` | string | No | — | Parameter name | | `Parameter33.Value` | string | No | — | Parameter value | | `Parameter34.Name` | string | No | — | Parameter name | | `Parameter34.Value` | string | No | — | Parameter value | | `Parameter35.Name` | string | No | — | Parameter name | | `Parameter35.Value` | string | No | — | Parameter value | | `Parameter36.Name` | string | No | — | Parameter name | | `Parameter36.Value` | string | No | — | Parameter value | | `Parameter37.Name` | string | No | — | Parameter name | | `Parameter37.Value` | string | No | — | Parameter value | | `Parameter38.Name` | string | No | — | Parameter name | | `Parameter38.Value` | string | No | — | Parameter value | | `Parameter39.Name` | string | No | — | Parameter name | | `Parameter39.Value` | string | No | — | Parameter value | | `Parameter4.Name` | string | No | — | Parameter name | | `Parameter4.Value` | string | No | — | Parameter value | | `Parameter40.Name` | string | No | — | Parameter name | | `Parameter40.Value` | string | No | — | Parameter value | | `Parameter41.Name` | string | No | — | Parameter name | | `Parameter41.Value` | string | No | — | Parameter value | | `Parameter42.Name` | string | No | — | Parameter name | | `Parameter42.Value` | string | No | — | Parameter value | | `Parameter43.Name` | string | No | — | Parameter name | | `Parameter43.Value` | string | No | — | Parameter value | | `Parameter44.Name` | string | No | — | Parameter name | | `Parameter44.Value` | string | No | — | Parameter value | | `Parameter45.Name` | string | No | — | Parameter name | | `Parameter45.Value` | string | No | — | Parameter value | | `Parameter46.Name` | string | No | — | Parameter name | | `Parameter46.Value` | string | No | — | Parameter value | | `Parameter47.Name` | string | No | — | Parameter name | | `Parameter47.Value` | string | No | — | Parameter value | | `Parameter48.Name` | string | No | — | Parameter name | | `Parameter48.Value` | string | No | — | Parameter value | | `Parameter49.Name` | string | No | — | Parameter name | | `Parameter49.Value` | string | No | — | Parameter value | | `Parameter5.Name` | string | No | — | Parameter name | | `Parameter5.Value` | string | No | — | Parameter value | | `Parameter50.Name` | string | No | — | Parameter name | | `Parameter50.Value` | string | No | — | Parameter value | | `Parameter51.Name` | string | No | — | Parameter name | | `Parameter51.Value` | string | No | — | Parameter value | | `Parameter52.Name` | string | No | — | Parameter name | | `Parameter52.Value` | string | No | — | Parameter value | | `Parameter53.Name` | string | No | — | Parameter name | | `Parameter53.Value` | string | No | — | Parameter value | | `Parameter54.Name` | string | No | — | Parameter name | | `Parameter54.Value` | string | No | — | Parameter value | | `Parameter55.Name` | string | No | — | Parameter name | | `Parameter55.Value` | string | No | — | Parameter value | | `Parameter56.Name` | string | No | — | Parameter name | | `Parameter56.Value` | string | No | — | Parameter value | | `Parameter57.Name` | string | No | — | Parameter name | | `Parameter57.Value` | string | No | — | Parameter value | | `Parameter58.Name` | string | No | — | Parameter name | | `Parameter58.Value` | string | No | — | Parameter value | | `Parameter59.Name` | string | No | — | Parameter name | | `Parameter59.Value` | string | No | — | Parameter value | | `Parameter6.Name` | string | No | — | Parameter name | | `Parameter6.Value` | string | No | — | Parameter value | | `Parameter60.Name` | string | No | — | Parameter name | | `Parameter60.Value` | string | No | — | Parameter value | | `Parameter61.Name` | string | No | — | Parameter name | | `Parameter61.Value` | string | No | — | Parameter value | | `Parameter62.Name` | string | No | — | Parameter name | | `Parameter62.Value` | string | No | — | Parameter value | | `Parameter63.Name` | string | No | — | Parameter name | | `Parameter63.Value` | string | No | — | Parameter value | | `Parameter64.Name` | string | No | — | Parameter name | | `Parameter64.Value` | string | No | — | Parameter value | | `Parameter65.Name` | string | No | — | Parameter name | | `Parameter65.Value` | string | No | — | Parameter value | | `Parameter66.Name` | string | No | — | Parameter name | | `Parameter66.Value` | string | No | — | Parameter value | | `Parameter67.Name` | string | No | — | Parameter name | | `Parameter67.Value` | string | No | — | Parameter value | | `Parameter68.Name` | string | No | — | Parameter name | | `Parameter68.Value` | string | No | — | Parameter value | | `Parameter69.Name` | string | No | — | Parameter name | | `Parameter69.Value` | string | No | — | Parameter value | | `Parameter7.Name` | string | No | — | Parameter name | | `Parameter7.Value` | string | No | — | Parameter value | | `Parameter70.Name` | string | No | — | Parameter name | | `Parameter70.Value` | string | No | — | Parameter value | | `Parameter71.Name` | string | No | — | Parameter name | | `Parameter71.Value` | string | No | — | Parameter value | | `Parameter72.Name` | string | No | — | Parameter name | | `Parameter72.Value` | string | No | — | Parameter value | | `Parameter73.Name` | string | No | — | Parameter name | | `Parameter73.Value` | string | No | — | Parameter value | | `Parameter74.Name` | string | No | — | Parameter name | | `Parameter74.Value` | string | No | — | Parameter value | | `Parameter75.Name` | string | No | — | Parameter name | | `Parameter75.Value` | string | No | — | Parameter value | | `Parameter76.Name` | string | No | — | Parameter name | | `Parameter76.Value` | string | No | — | Parameter value | | `Parameter77.Name` | string | No | — | Parameter name | | `Parameter77.Value` | string | No | — | Parameter value | | `Parameter78.Name` | string | No | — | Parameter name | | `Parameter78.Value` | string | No | — | Parameter value | | `Parameter79.Name` | string | No | — | Parameter name | | `Parameter79.Value` | string | No | — | Parameter value | | `Parameter8.Name` | string | No | — | Parameter name | | `Parameter8.Value` | string | No | — | Parameter value | | `Parameter80.Name` | string | No | — | Parameter name | | `Parameter80.Value` | string | No | — | Parameter value | | `Parameter81.Name` | string | No | — | Parameter name | | `Parameter81.Value` | string | No | — | Parameter value | | `Parameter82.Name` | string | No | — | Parameter name | | `Parameter82.Value` | string | No | — | Parameter value | | `Parameter83.Name` | string | No | — | Parameter name | | `Parameter83.Value` | string | No | — | Parameter value | | `Parameter84.Name` | string | No | — | Parameter name | | `Parameter84.Value` | string | No | — | Parameter value | | `Parameter85.Name` | string | No | — | Parameter name | | `Parameter85.Value` | string | No | — | Parameter value | | `Parameter86.Name` | string | No | — | Parameter name | | `Parameter86.Value` | string | No | — | Parameter value | | `Parameter87.Name` | string | No | — | Parameter name | | `Parameter87.Value` | string | No | — | Parameter value | | `Parameter88.Name` | string | No | — | Parameter name | | `Parameter88.Value` | string | No | — | Parameter value | | `Parameter89.Name` | string | No | — | Parameter name | | `Parameter89.Value` | string | No | — | Parameter value | | `Parameter9.Name` | string | No | — | Parameter name | | `Parameter9.Value` | string | No | — | Parameter value | | `Parameter90.Name` | string | No | — | Parameter name | | `Parameter90.Value` | string | No | — | Parameter value | | `Parameter91.Name` | string | No | — | Parameter name | | `Parameter91.Value` | string | No | — | Parameter value | | `Parameter92.Name` | string | No | — | Parameter name | | `Parameter92.Value` | string | No | — | Parameter value | | `Parameter93.Name` | string | No | — | Parameter name | | `Parameter93.Value` | string | No | — | Parameter value | | `Parameter94.Name` | string | No | — | Parameter name | | `Parameter94.Value` | string | No | — | Parameter value | | `Parameter95.Name` | string | No | — | Parameter name | | `Parameter95.Value` | string | No | — | Parameter value | | `Parameter96.Name` | string | No | — | Parameter name | | `Parameter96.Value` | string | No | — | Parameter value | | `Parameter97.Name` | string | No | — | Parameter name | | `Parameter97.Value` | string | No | — | Parameter value | | `Parameter98.Name` | string | No | — | Parameter name | | `Parameter98.Value` | string | No | — | Parameter value | | `Parameter99.Name` | string | No | — | Parameter name | | `Parameter99.Value` | string | No | — | Parameter value | | `StatusCallback` | string | No | — | Absolute URL of the status callback. | | `StatusCallbackMethod` | string | No | — | The http method for the status\_callback (one of GET, POST). | | `Track` | string | No | — | One of `inbound_track`, `outbound_track`, `both_tracks`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Siprec resource is associated with." }, "ConnectorName": { "type": "string", "description": "Unique name used when configuring the connector via Marketplace Add-on." }, "Name": { "type": "string", "description": "The user-specified name of this Siprec, if one was given when the Siprec was created. This may be used to stop the Siprec." }, "Parameter1.Name": { "type": "string", "description": "Parameter name" }, "Parameter1.Value": { "type": "string", "description": "Parameter value" }, "Parameter10.Name": { "type": "string", "description": "Parameter name" }, "Parameter10.Value": { "type": "string", "description": "Parameter value" }, "Parameter11.Name": { "type": "string", "description": "Parameter name" }, "Parameter11.Value": { "type": "string", "description": "Parameter value" }, "Parameter12.Name": { "type": "string", "description": "Parameter name" }, "Parameter12.Value": { "type": "string", "description": "Parameter value" }, "Parameter13.Name": { "type": "string", "description": "Parameter name" }, "Parameter13.Value": { "type": "string", "description": "Parameter value" }, "Parameter14.Name": { "type": "string", "description": "Parameter name" }, "Parameter14.Value": { "type": "string", "description": "Parameter value" }, "Parameter15.Name": { "type": "string", "description": "Parameter name" }, "Parameter15.Value": { "type": "string", "description": "Parameter value" }, "Parameter16.Name": { "type": "string", "description": "Parameter name" }, "Parameter16.Value": { "type": "string", "description": "Parameter value" }, "Parameter17.Name": { "type": "string", "description": "Parameter name" }, "Parameter17.Value": { "type": "string", "description": "Parameter value" }, "Parameter18.Name": { "type": "string", "description": "Parameter name" }, "Parameter18.Value": { "type": "string", "description": "Parameter value" }, "Parameter19.Name": { "type": "string", "description": "Parameter name" }, "Parameter19.Value": { "type": "string", "description": "Parameter value" }, "Parameter2.Name": { "type": "string", "description": "Parameter name" }, "Parameter2.Value": { "type": "string", "description": "Parameter value" }, "Parameter20.Name": { "type": "string", "description": "Parameter name" }, "Parameter20.Value": { "type": "string", "description": "Parameter value" }, "Parameter21.Name": { "type": "string", "description": "Parameter name" }, "Parameter21.Value": { "type": "string", "description": "Parameter value" }, "Parameter22.Name": { "type": "string", "description": "Parameter name" }, "Parameter22.Value": { "type": "string", "description": "Parameter value" }, "Parameter23.Name": { "type": "string", "description": "Parameter name" }, "Parameter23.Value": { "type": "string", "description": "Parameter value" }, "Parameter24.Name": { "type": "string", "description": "Parameter name" }, "Parameter24.Value": { "type": "string", "description": "Parameter value" }, "Parameter25.Name": { "type": "string", "description": "Parameter name" }, "Parameter25.Value": { "type": "string", "description": "Parameter value" }, "Parameter26.Name": { "type": "string", "description": "Parameter name" }, "Parameter26.Value": { "type": "string", "description": "Parameter value" }, "Parameter27.Name": { "type": "string", "description": "Parameter name" }, "Parameter27.Value": { "type": "string", "description": "Parameter value" }, "Parameter28.Name": { "type": "string", "description": "Parameter name" }, "Parameter28.Value": { "type": "string", "description": "Parameter value" }, "Parameter29.Name": { "type": "string", "description": "Parameter name" }, "Parameter29.Value": { "type": "string", "description": "Parameter value" }, "Parameter3.Name": { "type": "string", "description": "Parameter name" }, "Parameter3.Value": { "type": "string", "description": "Parameter value" }, "Parameter30.Name": { "type": "string", "description": "Parameter name" }, "Parameter30.Value": { "type": "string", "description": "Parameter value" }, "Parameter31.Name": { "type": "string", "description": "Parameter name" }, "Parameter31.Value": { "type": "string", "description": "Parameter value" }, "Parameter32.Name": { "type": "string", "description": "Parameter name" }, "Parameter32.Value": { "type": "string", "description": "Parameter value" }, "Parameter33.Name": { "type": "string", "description": "Parameter name" }, "Parameter33.Value": { "type": "string", "description": "Parameter value" }, "Parameter34.Name": { "type": "string", "description": "Parameter name" }, "Parameter34.Value": { "type": "string", "description": "Parameter value" }, "Parameter35.Name": { "type": "string", "description": "Parameter name" }, "Parameter35.Value": { "type": "string", "description": "Parameter value" }, "Parameter36.Name": { "type": "string", "description": "Parameter name" }, "Parameter36.Value": { "type": "string", "description": "Parameter value" }, "Parameter37.Name": { "type": "string", "description": "Parameter name" }, "Parameter37.Value": { "type": "string", "description": "Parameter value" }, "Parameter38.Name": { "type": "string", "description": "Parameter name" }, "Parameter38.Value": { "type": "string", "description": "Parameter value" }, "Parameter39.Name": { "type": "string", "description": "Parameter name" }, "Parameter39.Value": { "type": "string", "description": "Parameter value" }, "Parameter4.Name": { "type": "string", "description": "Parameter name" }, "Parameter4.Value": { "type": "string", "description": "Parameter value" }, "Parameter40.Name": { "type": "string", "description": "Parameter name" }, "Parameter40.Value": { "type": "string", "description": "Parameter value" }, "Parameter41.Name": { "type": "string", "description": "Parameter name" }, "Parameter41.Value": { "type": "string", "description": "Parameter value" }, "Parameter42.Name": { "type": "string", "description": "Parameter name" }, "Parameter42.Value": { "type": "string", "description": "Parameter value" }, "Parameter43.Name": { "type": "string", "description": "Parameter name" }, "Parameter43.Value": { "type": "string", "description": "Parameter value" }, "Parameter44.Name": { "type": "string", "description": "Parameter name" }, "Parameter44.Value": { "type": "string", "description": "Parameter value" }, "Parameter45.Name": { "type": "string", "description": "Parameter name" }, "Parameter45.Value": { "type": "string", "description": "Parameter value" }, "Parameter46.Name": { "type": "string", "description": "Parameter name" }, "Parameter46.Value": { "type": "string", "description": "Parameter value" }, "Parameter47.Name": { "type": "string", "description": "Parameter name" }, "Parameter47.Value": { "type": "string", "description": "Parameter value" }, "Parameter48.Name": { "type": "string", "description": "Parameter name" }, "Parameter48.Value": { "type": "string", "description": "Parameter value" }, "Parameter49.Name": { "type": "string", "description": "Parameter name" }, "Parameter49.Value": { "type": "string", "description": "Parameter value" }, "Parameter5.Name": { "type": "string", "description": "Parameter name" }, "Parameter5.Value": { "type": "string", "description": "Parameter value" }, "Parameter50.Name": { "type": "string", "description": "Parameter name" }, "Parameter50.Value": { "type": "string", "description": "Parameter value" }, "Parameter51.Name": { "type": "string", "description": "Parameter name" }, "Parameter51.Value": { "type": "string", "description": "Parameter value" }, "Parameter52.Name": { "type": "string", "description": "Parameter name" }, "Parameter52.Value": { "type": "string", "description": "Parameter value" }, "Parameter53.Name": { "type": "string", "description": "Parameter name" }, "Parameter53.Value": { "type": "string", "description": "Parameter value" }, "Parameter54.Name": { "type": "string", "description": "Parameter name" }, "Parameter54.Value": { "type": "string", "description": "Parameter value" }, "Parameter55.Name": { "type": "string", "description": "Parameter name" }, "Parameter55.Value": { "type": "string", "description": "Parameter value" }, "Parameter56.Name": { "type": "string", "description": "Parameter name" }, "Parameter56.Value": { "type": "string", "description": "Parameter value" }, "Parameter57.Name": { "type": "string", "description": "Parameter name" }, "Parameter57.Value": { "type": "string", "description": "Parameter value" }, "Parameter58.Name": { "type": "string", "description": "Parameter name" }, "Parameter58.Value": { "type": "string", "description": "Parameter value" }, "Parameter59.Name": { "type": "string", "description": "Parameter name" }, "Parameter59.Value": { "type": "string", "description": "Parameter value" }, "Parameter6.Name": { "type": "string", "description": "Parameter name" }, "Parameter6.Value": { "type": "string", "description": "Parameter value" }, "Parameter60.Name": { "type": "string", "description": "Parameter name" }, "Parameter60.Value": { "type": "string", "description": "Parameter value" }, "Parameter61.Name": { "type": "string", "description": "Parameter name" }, "Parameter61.Value": { "type": "string", "description": "Parameter value" }, "Parameter62.Name": { "type": "string", "description": "Parameter name" }, "Parameter62.Value": { "type": "string", "description": "Parameter value" }, "Parameter63.Name": { "type": "string", "description": "Parameter name" }, "Parameter63.Value": { "type": "string", "description": "Parameter value" }, "Parameter64.Name": { "type": "string", "description": "Parameter name" }, "Parameter64.Value": { "type": "string", "description": "Parameter value" }, "Parameter65.Name": { "type": "string", "description": "Parameter name" }, "Parameter65.Value": { "type": "string", "description": "Parameter value" }, "Parameter66.Name": { "type": "string", "description": "Parameter name" }, "Parameter66.Value": { "type": "string", "description": "Parameter value" }, "Parameter67.Name": { "type": "string", "description": "Parameter name" }, "Parameter67.Value": { "type": "string", "description": "Parameter value" }, "Parameter68.Name": { "type": "string", "description": "Parameter name" }, "Parameter68.Value": { "type": "string", "description": "Parameter value" }, "Parameter69.Name": { "type": "string", "description": "Parameter name" }, "Parameter69.Value": { "type": "string", "description": "Parameter value" }, "Parameter7.Name": { "type": "string", "description": "Parameter name" }, "Parameter7.Value": { "type": "string", "description": "Parameter value" }, "Parameter70.Name": { "type": "string", "description": "Parameter name" }, "Parameter70.Value": { "type": "string", "description": "Parameter value" }, "Parameter71.Name": { "type": "string", "description": "Parameter name" }, "Parameter71.Value": { "type": "string", "description": "Parameter value" }, "Parameter72.Name": { "type": "string", "description": "Parameter name" }, "Parameter72.Value": { "type": "string", "description": "Parameter value" }, "Parameter73.Name": { "type": "string", "description": "Parameter name" }, "Parameter73.Value": { "type": "string", "description": "Parameter value" }, "Parameter74.Name": { "type": "string", "description": "Parameter name" }, "Parameter74.Value": { "type": "string", "description": "Parameter value" }, "Parameter75.Name": { "type": "string", "description": "Parameter name" }, "Parameter75.Value": { "type": "string", "description": "Parameter value" }, "Parameter76.Name": { "type": "string", "description": "Parameter name" }, "Parameter76.Value": { "type": "string", "description": "Parameter value" }, "Parameter77.Name": { "type": "string", "description": "Parameter name" }, "Parameter77.Value": { "type": "string", "description": "Parameter value" }, "Parameter78.Name": { "type": "string", "description": "Parameter name" }, "Parameter78.Value": { "type": "string", "description": "Parameter value" }, "Parameter79.Name": { "type": "string", "description": "Parameter name" }, "Parameter79.Value": { "type": "string", "description": "Parameter value" }, "Parameter8.Name": { "type": "string", "description": "Parameter name" }, "Parameter8.Value": { "type": "string", "description": "Parameter value" }, "Parameter80.Name": { "type": "string", "description": "Parameter name" }, "Parameter80.Value": { "type": "string", "description": "Parameter value" }, "Parameter81.Name": { "type": "string", "description": "Parameter name" }, "Parameter81.Value": { "type": "string", "description": "Parameter value" }, "Parameter82.Name": { "type": "string", "description": "Parameter name" }, "Parameter82.Value": { "type": "string", "description": "Parameter value" }, "Parameter83.Name": { "type": "string", "description": "Parameter name" }, "Parameter83.Value": { "type": "string", "description": "Parameter value" }, "Parameter84.Name": { "type": "string", "description": "Parameter name" }, "Parameter84.Value": { "type": "string", "description": "Parameter value" }, "Parameter85.Name": { "type": "string", "description": "Parameter name" }, "Parameter85.Value": { "type": "string", "description": "Parameter value" }, "Parameter86.Name": { "type": "string", "description": "Parameter name" }, "Parameter86.Value": { "type": "string", "description": "Parameter value" }, "Parameter87.Name": { "type": "string", "description": "Parameter name" }, "Parameter87.Value": { "type": "string", "description": "Parameter value" }, "Parameter88.Name": { "type": "string", "description": "Parameter name" }, "Parameter88.Value": { "type": "string", "description": "Parameter value" }, "Parameter89.Name": { "type": "string", "description": "Parameter name" }, "Parameter89.Value": { "type": "string", "description": "Parameter value" }, "Parameter9.Name": { "type": "string", "description": "Parameter name" }, "Parameter9.Value": { "type": "string", "description": "Parameter value" }, "Parameter90.Name": { "type": "string", "description": "Parameter name" }, "Parameter90.Value": { "type": "string", "description": "Parameter value" }, "Parameter91.Name": { "type": "string", "description": "Parameter name" }, "Parameter91.Value": { "type": "string", "description": "Parameter value" }, "Parameter92.Name": { "type": "string", "description": "Parameter name" }, "Parameter92.Value": { "type": "string", "description": "Parameter value" }, "Parameter93.Name": { "type": "string", "description": "Parameter name" }, "Parameter93.Value": { "type": "string", "description": "Parameter value" }, "Parameter94.Name": { "type": "string", "description": "Parameter name" }, "Parameter94.Value": { "type": "string", "description": "Parameter value" }, "Parameter95.Name": { "type": "string", "description": "Parameter name" }, "Parameter95.Value": { "type": "string", "description": "Parameter value" }, "Parameter96.Name": { "type": "string", "description": "Parameter name" }, "Parameter96.Value": { "type": "string", "description": "Parameter value" }, "Parameter97.Name": { "type": "string", "description": "Parameter name" }, "Parameter97.Value": { "type": "string", "description": "Parameter value" }, "Parameter98.Name": { "type": "string", "description": "Parameter name" }, "Parameter98.Value": { "type": "string", "description": "Parameter value" }, "Parameter99.Name": { "type": "string", "description": "Parameter name" }, "Parameter99.Value": { "type": "string", "description": "Parameter value" }, "StatusCallback": { "type": "string", "description": "Absolute URL of the status callback." }, "StatusCallbackMethod": { "type": "string", "description": "The http method for the status_callback (one of GET, POST).", "enum": [ "GET", "POST" ] }, "Track": { "type": "string", "description": "One of `inbound_track`, `outbound_track`, `both_tracks`.", "enum": [ "inbound_track", "outbound_track", "both_tracks" ] } }, "required": [ "PCID", "CallSid" ] } ``` *** ## twilio\_voice\_create\_stream Create a Stream **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `CallSid` | string | Yes | — | The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Stream resource is associated with. | | `Name` | string | No | — | The user-specified name of this Stream, if one was given when the Stream was created. This can be used to stop the Stream. | | `Parameter1.Name` | string | No | — | Parameter name | | `Parameter1.Value` | string | No | — | Parameter value | | `Parameter10.Name` | string | No | — | Parameter name | | `Parameter10.Value` | string | No | — | Parameter value | | `Parameter11.Name` | string | No | — | Parameter name | | `Parameter11.Value` | string | No | — | Parameter value | | `Parameter12.Name` | string | No | — | Parameter name | | `Parameter12.Value` | string | No | — | Parameter value | | `Parameter13.Name` | string | No | — | Parameter name | | `Parameter13.Value` | string | No | — | Parameter value | | `Parameter14.Name` | string | No | — | Parameter name | | `Parameter14.Value` | string | No | — | Parameter value | | `Parameter15.Name` | string | No | — | Parameter name | | `Parameter15.Value` | string | No | — | Parameter value | | `Parameter16.Name` | string | No | — | Parameter name | | `Parameter16.Value` | string | No | — | Parameter value | | `Parameter17.Name` | string | No | — | Parameter name | | `Parameter17.Value` | string | No | — | Parameter value | | `Parameter18.Name` | string | No | — | Parameter name | | `Parameter18.Value` | string | No | — | Parameter value | | `Parameter19.Name` | string | No | — | Parameter name | | `Parameter19.Value` | string | No | — | Parameter value | | `Parameter2.Name` | string | No | — | Parameter name | | `Parameter2.Value` | string | No | — | Parameter value | | `Parameter20.Name` | string | No | — | Parameter name | | `Parameter20.Value` | string | No | — | Parameter value | | `Parameter21.Name` | string | No | — | Parameter name | | `Parameter21.Value` | string | No | — | Parameter value | | `Parameter22.Name` | string | No | — | Parameter name | | `Parameter22.Value` | string | No | — | Parameter value | | `Parameter23.Name` | string | No | — | Parameter name | | `Parameter23.Value` | string | No | — | Parameter value | | `Parameter24.Name` | string | No | — | Parameter name | | `Parameter24.Value` | string | No | — | Parameter value | | `Parameter25.Name` | string | No | — | Parameter name | | `Parameter25.Value` | string | No | — | Parameter value | | `Parameter26.Name` | string | No | — | Parameter name | | `Parameter26.Value` | string | No | — | Parameter value | | `Parameter27.Name` | string | No | — | Parameter name | | `Parameter27.Value` | string | No | — | Parameter value | | `Parameter28.Name` | string | No | — | Parameter name | | `Parameter28.Value` | string | No | — | Parameter value | | `Parameter29.Name` | string | No | — | Parameter name | | `Parameter29.Value` | string | No | — | Parameter value | | `Parameter3.Name` | string | No | — | Parameter name | | `Parameter3.Value` | string | No | — | Parameter value | | `Parameter30.Name` | string | No | — | Parameter name | | `Parameter30.Value` | string | No | — | Parameter value | | `Parameter31.Name` | string | No | — | Parameter name | | `Parameter31.Value` | string | No | — | Parameter value | | `Parameter32.Name` | string | No | — | Parameter name | | `Parameter32.Value` | string | No | — | Parameter value | | `Parameter33.Name` | string | No | — | Parameter name | | `Parameter33.Value` | string | No | — | Parameter value | | `Parameter34.Name` | string | No | — | Parameter name | | `Parameter34.Value` | string | No | — | Parameter value | | `Parameter35.Name` | string | No | — | Parameter name | | `Parameter35.Value` | string | No | — | Parameter value | | `Parameter36.Name` | string | No | — | Parameter name | | `Parameter36.Value` | string | No | — | Parameter value | | `Parameter37.Name` | string | No | — | Parameter name | | `Parameter37.Value` | string | No | — | Parameter value | | `Parameter38.Name` | string | No | — | Parameter name | | `Parameter38.Value` | string | No | — | Parameter value | | `Parameter39.Name` | string | No | — | Parameter name | | `Parameter39.Value` | string | No | — | Parameter value | | `Parameter4.Name` | string | No | — | Parameter name | | `Parameter4.Value` | string | No | — | Parameter value | | `Parameter40.Name` | string | No | — | Parameter name | | `Parameter40.Value` | string | No | — | Parameter value | | `Parameter41.Name` | string | No | — | Parameter name | | `Parameter41.Value` | string | No | — | Parameter value | | `Parameter42.Name` | string | No | — | Parameter name | | `Parameter42.Value` | string | No | — | Parameter value | | `Parameter43.Name` | string | No | — | Parameter name | | `Parameter43.Value` | string | No | — | Parameter value | | `Parameter44.Name` | string | No | — | Parameter name | | `Parameter44.Value` | string | No | — | Parameter value | | `Parameter45.Name` | string | No | — | Parameter name | | `Parameter45.Value` | string | No | — | Parameter value | | `Parameter46.Name` | string | No | — | Parameter name | | `Parameter46.Value` | string | No | — | Parameter value | | `Parameter47.Name` | string | No | — | Parameter name | | `Parameter47.Value` | string | No | — | Parameter value | | `Parameter48.Name` | string | No | — | Parameter name | | `Parameter48.Value` | string | No | — | Parameter value | | `Parameter49.Name` | string | No | — | Parameter name | | `Parameter49.Value` | string | No | — | Parameter value | | `Parameter5.Name` | string | No | — | Parameter name | | `Parameter5.Value` | string | No | — | Parameter value | | `Parameter50.Name` | string | No | — | Parameter name | | `Parameter50.Value` | string | No | — | Parameter value | | `Parameter51.Name` | string | No | — | Parameter name | | `Parameter51.Value` | string | No | — | Parameter value | | `Parameter52.Name` | string | No | — | Parameter name | | `Parameter52.Value` | string | No | — | Parameter value | | `Parameter53.Name` | string | No | — | Parameter name | | `Parameter53.Value` | string | No | — | Parameter value | | `Parameter54.Name` | string | No | — | Parameter name | | `Parameter54.Value` | string | No | — | Parameter value | | `Parameter55.Name` | string | No | — | Parameter name | | `Parameter55.Value` | string | No | — | Parameter value | | `Parameter56.Name` | string | No | — | Parameter name | | `Parameter56.Value` | string | No | — | Parameter value | | `Parameter57.Name` | string | No | — | Parameter name | | `Parameter57.Value` | string | No | — | Parameter value | | `Parameter58.Name` | string | No | — | Parameter name | | `Parameter58.Value` | string | No | — | Parameter value | | `Parameter59.Name` | string | No | — | Parameter name | | `Parameter59.Value` | string | No | — | Parameter value | | `Parameter6.Name` | string | No | — | Parameter name | | `Parameter6.Value` | string | No | — | Parameter value | | `Parameter60.Name` | string | No | — | Parameter name | | `Parameter60.Value` | string | No | — | Parameter value | | `Parameter61.Name` | string | No | — | Parameter name | | `Parameter61.Value` | string | No | — | Parameter value | | `Parameter62.Name` | string | No | — | Parameter name | | `Parameter62.Value` | string | No | — | Parameter value | | `Parameter63.Name` | string | No | — | Parameter name | | `Parameter63.Value` | string | No | — | Parameter value | | `Parameter64.Name` | string | No | — | Parameter name | | `Parameter64.Value` | string | No | — | Parameter value | | `Parameter65.Name` | string | No | — | Parameter name | | `Parameter65.Value` | string | No | — | Parameter value | | `Parameter66.Name` | string | No | — | Parameter name | | `Parameter66.Value` | string | No | — | Parameter value | | `Parameter67.Name` | string | No | — | Parameter name | | `Parameter67.Value` | string | No | — | Parameter value | | `Parameter68.Name` | string | No | — | Parameter name | | `Parameter68.Value` | string | No | — | Parameter value | | `Parameter69.Name` | string | No | — | Parameter name | | `Parameter69.Value` | string | No | — | Parameter value | | `Parameter7.Name` | string | No | — | Parameter name | | `Parameter7.Value` | string | No | — | Parameter value | | `Parameter70.Name` | string | No | — | Parameter name | | `Parameter70.Value` | string | No | — | Parameter value | | `Parameter71.Name` | string | No | — | Parameter name | | `Parameter71.Value` | string | No | — | Parameter value | | `Parameter72.Name` | string | No | — | Parameter name | | `Parameter72.Value` | string | No | — | Parameter value | | `Parameter73.Name` | string | No | — | Parameter name | | `Parameter73.Value` | string | No | — | Parameter value | | `Parameter74.Name` | string | No | — | Parameter name | | `Parameter74.Value` | string | No | — | Parameter value | | `Parameter75.Name` | string | No | — | Parameter name | | `Parameter75.Value` | string | No | — | Parameter value | | `Parameter76.Name` | string | No | — | Parameter name | | `Parameter76.Value` | string | No | — | Parameter value | | `Parameter77.Name` | string | No | — | Parameter name | | `Parameter77.Value` | string | No | — | Parameter value | | `Parameter78.Name` | string | No | — | Parameter name | | `Parameter78.Value` | string | No | — | Parameter value | | `Parameter79.Name` | string | No | — | Parameter name | | `Parameter79.Value` | string | No | — | Parameter value | | `Parameter8.Name` | string | No | — | Parameter name | | `Parameter8.Value` | string | No | — | Parameter value | | `Parameter80.Name` | string | No | — | Parameter name | | `Parameter80.Value` | string | No | — | Parameter value | | `Parameter81.Name` | string | No | — | Parameter name | | `Parameter81.Value` | string | No | — | Parameter value | | `Parameter82.Name` | string | No | — | Parameter name | | `Parameter82.Value` | string | No | — | Parameter value | | `Parameter83.Name` | string | No | — | Parameter name | | `Parameter83.Value` | string | No | — | Parameter value | | `Parameter84.Name` | string | No | — | Parameter name | | `Parameter84.Value` | string | No | — | Parameter value | | `Parameter85.Name` | string | No | — | Parameter name | | `Parameter85.Value` | string | No | — | Parameter value | | `Parameter86.Name` | string | No | — | Parameter name | | `Parameter86.Value` | string | No | — | Parameter value | | `Parameter87.Name` | string | No | — | Parameter name | | `Parameter87.Value` | string | No | — | Parameter value | | `Parameter88.Name` | string | No | — | Parameter name | | `Parameter88.Value` | string | No | — | Parameter value | | `Parameter89.Name` | string | No | — | Parameter name | | `Parameter89.Value` | string | No | — | Parameter value | | `Parameter9.Name` | string | No | — | Parameter name | | `Parameter9.Value` | string | No | — | Parameter value | | `Parameter90.Name` | string | No | — | Parameter name | | `Parameter90.Value` | string | No | — | Parameter value | | `Parameter91.Name` | string | No | — | Parameter name | | `Parameter91.Value` | string | No | — | Parameter value | | `Parameter92.Name` | string | No | — | Parameter name | | `Parameter92.Value` | string | No | — | Parameter value | | `Parameter93.Name` | string | No | — | Parameter name | | `Parameter93.Value` | string | No | — | Parameter value | | `Parameter94.Name` | string | No | — | Parameter name | | `Parameter94.Value` | string | No | — | Parameter value | | `Parameter95.Name` | string | No | — | Parameter name | | `Parameter95.Value` | string | No | — | Parameter value | | `Parameter96.Name` | string | No | — | Parameter name | | `Parameter96.Value` | string | No | — | Parameter value | | `Parameter97.Name` | string | No | — | Parameter name | | `Parameter97.Value` | string | No | — | Parameter value | | `Parameter98.Name` | string | No | — | Parameter name | | `Parameter98.Value` | string | No | — | Parameter value | | `Parameter99.Name` | string | No | — | Parameter name | | `Parameter99.Value` | string | No | — | Parameter value | | `StatusCallback` | string | No | — | Absolute URL to which Twilio sends status callback HTTP requests. | | `StatusCallbackMethod` | string | No | — | The HTTP method Twilio uses when sending `status_callback` requests. Possible values are `GET` and `POST`. Default is `POST`. | | `Track` | string | No | — | The tracks to be included in the Stream. Possible values are `inbound_track`, `outbound_track`, `both_tracks`. Default value is `inbound_track`. | | `Url` | string | Yes | — | Relative or absolute URL where WebSocket connection will be established. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Stream resource is associated with." }, "Name": { "type": "string", "description": "The user-specified name of this Stream, if one was given when the Stream was created. This can be used to stop the Stream." }, "Parameter1.Name": { "type": "string", "description": "Parameter name" }, "Parameter1.Value": { "type": "string", "description": "Parameter value" }, "Parameter10.Name": { "type": "string", "description": "Parameter name" }, "Parameter10.Value": { "type": "string", "description": "Parameter value" }, "Parameter11.Name": { "type": "string", "description": "Parameter name" }, "Parameter11.Value": { "type": "string", "description": "Parameter value" }, "Parameter12.Name": { "type": "string", "description": "Parameter name" }, "Parameter12.Value": { "type": "string", "description": "Parameter value" }, "Parameter13.Name": { "type": "string", "description": "Parameter name" }, "Parameter13.Value": { "type": "string", "description": "Parameter value" }, "Parameter14.Name": { "type": "string", "description": "Parameter name" }, "Parameter14.Value": { "type": "string", "description": "Parameter value" }, "Parameter15.Name": { "type": "string", "description": "Parameter name" }, "Parameter15.Value": { "type": "string", "description": "Parameter value" }, "Parameter16.Name": { "type": "string", "description": "Parameter name" }, "Parameter16.Value": { "type": "string", "description": "Parameter value" }, "Parameter17.Name": { "type": "string", "description": "Parameter name" }, "Parameter17.Value": { "type": "string", "description": "Parameter value" }, "Parameter18.Name": { "type": "string", "description": "Parameter name" }, "Parameter18.Value": { "type": "string", "description": "Parameter value" }, "Parameter19.Name": { "type": "string", "description": "Parameter name" }, "Parameter19.Value": { "type": "string", "description": "Parameter value" }, "Parameter2.Name": { "type": "string", "description": "Parameter name" }, "Parameter2.Value": { "type": "string", "description": "Parameter value" }, "Parameter20.Name": { "type": "string", "description": "Parameter name" }, "Parameter20.Value": { "type": "string", "description": "Parameter value" }, "Parameter21.Name": { "type": "string", "description": "Parameter name" }, "Parameter21.Value": { "type": "string", "description": "Parameter value" }, "Parameter22.Name": { "type": "string", "description": "Parameter name" }, "Parameter22.Value": { "type": "string", "description": "Parameter value" }, "Parameter23.Name": { "type": "string", "description": "Parameter name" }, "Parameter23.Value": { "type": "string", "description": "Parameter value" }, "Parameter24.Name": { "type": "string", "description": "Parameter name" }, "Parameter24.Value": { "type": "string", "description": "Parameter value" }, "Parameter25.Name": { "type": "string", "description": "Parameter name" }, "Parameter25.Value": { "type": "string", "description": "Parameter value" }, "Parameter26.Name": { "type": "string", "description": "Parameter name" }, "Parameter26.Value": { "type": "string", "description": "Parameter value" }, "Parameter27.Name": { "type": "string", "description": "Parameter name" }, "Parameter27.Value": { "type": "string", "description": "Parameter value" }, "Parameter28.Name": { "type": "string", "description": "Parameter name" }, "Parameter28.Value": { "type": "string", "description": "Parameter value" }, "Parameter29.Name": { "type": "string", "description": "Parameter name" }, "Parameter29.Value": { "type": "string", "description": "Parameter value" }, "Parameter3.Name": { "type": "string", "description": "Parameter name" }, "Parameter3.Value": { "type": "string", "description": "Parameter value" }, "Parameter30.Name": { "type": "string", "description": "Parameter name" }, "Parameter30.Value": { "type": "string", "description": "Parameter value" }, "Parameter31.Name": { "type": "string", "description": "Parameter name" }, "Parameter31.Value": { "type": "string", "description": "Parameter value" }, "Parameter32.Name": { "type": "string", "description": "Parameter name" }, "Parameter32.Value": { "type": "string", "description": "Parameter value" }, "Parameter33.Name": { "type": "string", "description": "Parameter name" }, "Parameter33.Value": { "type": "string", "description": "Parameter value" }, "Parameter34.Name": { "type": "string", "description": "Parameter name" }, "Parameter34.Value": { "type": "string", "description": "Parameter value" }, "Parameter35.Name": { "type": "string", "description": "Parameter name" }, "Parameter35.Value": { "type": "string", "description": "Parameter value" }, "Parameter36.Name": { "type": "string", "description": "Parameter name" }, "Parameter36.Value": { "type": "string", "description": "Parameter value" }, "Parameter37.Name": { "type": "string", "description": "Parameter name" }, "Parameter37.Value": { "type": "string", "description": "Parameter value" }, "Parameter38.Name": { "type": "string", "description": "Parameter name" }, "Parameter38.Value": { "type": "string", "description": "Parameter value" }, "Parameter39.Name": { "type": "string", "description": "Parameter name" }, "Parameter39.Value": { "type": "string", "description": "Parameter value" }, "Parameter4.Name": { "type": "string", "description": "Parameter name" }, "Parameter4.Value": { "type": "string", "description": "Parameter value" }, "Parameter40.Name": { "type": "string", "description": "Parameter name" }, "Parameter40.Value": { "type": "string", "description": "Parameter value" }, "Parameter41.Name": { "type": "string", "description": "Parameter name" }, "Parameter41.Value": { "type": "string", "description": "Parameter value" }, "Parameter42.Name": { "type": "string", "description": "Parameter name" }, "Parameter42.Value": { "type": "string", "description": "Parameter value" }, "Parameter43.Name": { "type": "string", "description": "Parameter name" }, "Parameter43.Value": { "type": "string", "description": "Parameter value" }, "Parameter44.Name": { "type": "string", "description": "Parameter name" }, "Parameter44.Value": { "type": "string", "description": "Parameter value" }, "Parameter45.Name": { "type": "string", "description": "Parameter name" }, "Parameter45.Value": { "type": "string", "description": "Parameter value" }, "Parameter46.Name": { "type": "string", "description": "Parameter name" }, "Parameter46.Value": { "type": "string", "description": "Parameter value" }, "Parameter47.Name": { "type": "string", "description": "Parameter name" }, "Parameter47.Value": { "type": "string", "description": "Parameter value" }, "Parameter48.Name": { "type": "string", "description": "Parameter name" }, "Parameter48.Value": { "type": "string", "description": "Parameter value" }, "Parameter49.Name": { "type": "string", "description": "Parameter name" }, "Parameter49.Value": { "type": "string", "description": "Parameter value" }, "Parameter5.Name": { "type": "string", "description": "Parameter name" }, "Parameter5.Value": { "type": "string", "description": "Parameter value" }, "Parameter50.Name": { "type": "string", "description": "Parameter name" }, "Parameter50.Value": { "type": "string", "description": "Parameter value" }, "Parameter51.Name": { "type": "string", "description": "Parameter name" }, "Parameter51.Value": { "type": "string", "description": "Parameter value" }, "Parameter52.Name": { "type": "string", "description": "Parameter name" }, "Parameter52.Value": { "type": "string", "description": "Parameter value" }, "Parameter53.Name": { "type": "string", "description": "Parameter name" }, "Parameter53.Value": { "type": "string", "description": "Parameter value" }, "Parameter54.Name": { "type": "string", "description": "Parameter name" }, "Parameter54.Value": { "type": "string", "description": "Parameter value" }, "Parameter55.Name": { "type": "string", "description": "Parameter name" }, "Parameter55.Value": { "type": "string", "description": "Parameter value" }, "Parameter56.Name": { "type": "string", "description": "Parameter name" }, "Parameter56.Value": { "type": "string", "description": "Parameter value" }, "Parameter57.Name": { "type": "string", "description": "Parameter name" }, "Parameter57.Value": { "type": "string", "description": "Parameter value" }, "Parameter58.Name": { "type": "string", "description": "Parameter name" }, "Parameter58.Value": { "type": "string", "description": "Parameter value" }, "Parameter59.Name": { "type": "string", "description": "Parameter name" }, "Parameter59.Value": { "type": "string", "description": "Parameter value" }, "Parameter6.Name": { "type": "string", "description": "Parameter name" }, "Parameter6.Value": { "type": "string", "description": "Parameter value" }, "Parameter60.Name": { "type": "string", "description": "Parameter name" }, "Parameter60.Value": { "type": "string", "description": "Parameter value" }, "Parameter61.Name": { "type": "string", "description": "Parameter name" }, "Parameter61.Value": { "type": "string", "description": "Parameter value" }, "Parameter62.Name": { "type": "string", "description": "Parameter name" }, "Parameter62.Value": { "type": "string", "description": "Parameter value" }, "Parameter63.Name": { "type": "string", "description": "Parameter name" }, "Parameter63.Value": { "type": "string", "description": "Parameter value" }, "Parameter64.Name": { "type": "string", "description": "Parameter name" }, "Parameter64.Value": { "type": "string", "description": "Parameter value" }, "Parameter65.Name": { "type": "string", "description": "Parameter name" }, "Parameter65.Value": { "type": "string", "description": "Parameter value" }, "Parameter66.Name": { "type": "string", "description": "Parameter name" }, "Parameter66.Value": { "type": "string", "description": "Parameter value" }, "Parameter67.Name": { "type": "string", "description": "Parameter name" }, "Parameter67.Value": { "type": "string", "description": "Parameter value" }, "Parameter68.Name": { "type": "string", "description": "Parameter name" }, "Parameter68.Value": { "type": "string", "description": "Parameter value" }, "Parameter69.Name": { "type": "string", "description": "Parameter name" }, "Parameter69.Value": { "type": "string", "description": "Parameter value" }, "Parameter7.Name": { "type": "string", "description": "Parameter name" }, "Parameter7.Value": { "type": "string", "description": "Parameter value" }, "Parameter70.Name": { "type": "string", "description": "Parameter name" }, "Parameter70.Value": { "type": "string", "description": "Parameter value" }, "Parameter71.Name": { "type": "string", "description": "Parameter name" }, "Parameter71.Value": { "type": "string", "description": "Parameter value" }, "Parameter72.Name": { "type": "string", "description": "Parameter name" }, "Parameter72.Value": { "type": "string", "description": "Parameter value" }, "Parameter73.Name": { "type": "string", "description": "Parameter name" }, "Parameter73.Value": { "type": "string", "description": "Parameter value" }, "Parameter74.Name": { "type": "string", "description": "Parameter name" }, "Parameter74.Value": { "type": "string", "description": "Parameter value" }, "Parameter75.Name": { "type": "string", "description": "Parameter name" }, "Parameter75.Value": { "type": "string", "description": "Parameter value" }, "Parameter76.Name": { "type": "string", "description": "Parameter name" }, "Parameter76.Value": { "type": "string", "description": "Parameter value" }, "Parameter77.Name": { "type": "string", "description": "Parameter name" }, "Parameter77.Value": { "type": "string", "description": "Parameter value" }, "Parameter78.Name": { "type": "string", "description": "Parameter name" }, "Parameter78.Value": { "type": "string", "description": "Parameter value" }, "Parameter79.Name": { "type": "string", "description": "Parameter name" }, "Parameter79.Value": { "type": "string", "description": "Parameter value" }, "Parameter8.Name": { "type": "string", "description": "Parameter name" }, "Parameter8.Value": { "type": "string", "description": "Parameter value" }, "Parameter80.Name": { "type": "string", "description": "Parameter name" }, "Parameter80.Value": { "type": "string", "description": "Parameter value" }, "Parameter81.Name": { "type": "string", "description": "Parameter name" }, "Parameter81.Value": { "type": "string", "description": "Parameter value" }, "Parameter82.Name": { "type": "string", "description": "Parameter name" }, "Parameter82.Value": { "type": "string", "description": "Parameter value" }, "Parameter83.Name": { "type": "string", "description": "Parameter name" }, "Parameter83.Value": { "type": "string", "description": "Parameter value" }, "Parameter84.Name": { "type": "string", "description": "Parameter name" }, "Parameter84.Value": { "type": "string", "description": "Parameter value" }, "Parameter85.Name": { "type": "string", "description": "Parameter name" }, "Parameter85.Value": { "type": "string", "description": "Parameter value" }, "Parameter86.Name": { "type": "string", "description": "Parameter name" }, "Parameter86.Value": { "type": "string", "description": "Parameter value" }, "Parameter87.Name": { "type": "string", "description": "Parameter name" }, "Parameter87.Value": { "type": "string", "description": "Parameter value" }, "Parameter88.Name": { "type": "string", "description": "Parameter name" }, "Parameter88.Value": { "type": "string", "description": "Parameter value" }, "Parameter89.Name": { "type": "string", "description": "Parameter name" }, "Parameter89.Value": { "type": "string", "description": "Parameter value" }, "Parameter9.Name": { "type": "string", "description": "Parameter name" }, "Parameter9.Value": { "type": "string", "description": "Parameter value" }, "Parameter90.Name": { "type": "string", "description": "Parameter name" }, "Parameter90.Value": { "type": "string", "description": "Parameter value" }, "Parameter91.Name": { "type": "string", "description": "Parameter name" }, "Parameter91.Value": { "type": "string", "description": "Parameter value" }, "Parameter92.Name": { "type": "string", "description": "Parameter name" }, "Parameter92.Value": { "type": "string", "description": "Parameter value" }, "Parameter93.Name": { "type": "string", "description": "Parameter name" }, "Parameter93.Value": { "type": "string", "description": "Parameter value" }, "Parameter94.Name": { "type": "string", "description": "Parameter name" }, "Parameter94.Value": { "type": "string", "description": "Parameter value" }, "Parameter95.Name": { "type": "string", "description": "Parameter name" }, "Parameter95.Value": { "type": "string", "description": "Parameter value" }, "Parameter96.Name": { "type": "string", "description": "Parameter name" }, "Parameter96.Value": { "type": "string", "description": "Parameter value" }, "Parameter97.Name": { "type": "string", "description": "Parameter name" }, "Parameter97.Value": { "type": "string", "description": "Parameter value" }, "Parameter98.Name": { "type": "string", "description": "Parameter name" }, "Parameter98.Value": { "type": "string", "description": "Parameter value" }, "Parameter99.Name": { "type": "string", "description": "Parameter name" }, "Parameter99.Value": { "type": "string", "description": "Parameter value" }, "StatusCallback": { "type": "string", "description": "Absolute URL to which Twilio sends status callback HTTP requests." }, "StatusCallbackMethod": { "type": "string", "description": "The HTTP method Twilio uses when sending `status_callback` requests. Possible values are `GET` and `POST`. Default is `POST`.", "enum": [ "GET", "POST" ] }, "Track": { "type": "string", "description": "The tracks to be included in the Stream. Possible values are `inbound_track`, `outbound_track`, `both_tracks`. Default value is `inbound_track`.", "enum": [ "inbound_track", "outbound_track", "both_tracks" ] }, "Url": { "type": "string", "description": "Relative or absolute URL where WebSocket connection will be established." } }, "required": [ "PCID", "CallSid", "Url" ] } ``` *** ## twilio\_voice\_create\_user\_defined\_message Create a new User Defined Message for the given Call SID. **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `CallSid` | string | Yes | — | The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the User Defined Message is associated with. | | `Content` | string | Yes | — | The User Defined Message in the form of URL-encoded JSON string. | | `IdempotencyKey` | string | No | — | A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the User Defined Message is associated with." }, "Content": { "type": "string", "description": "The User Defined Message in the form of URL-encoded JSON string." }, "IdempotencyKey": { "type": "string", "description": "A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated." } }, "required": [ "PCID", "CallSid", "Content" ] } ``` *** ## twilio\_voice\_create\_user\_defined\_message\_subscription Subscribe to User Defined Messages for a given Call SID. **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `CallSid` | string | Yes | — | The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the User Defined Messages subscription is associated with. This refers to the Call SID that is producing the user defined messages. | | `Callback` | string | Yes | — | The URL we should call using the `method` to send user defined events to your application. URLs must contain a valid hostname (underscores are not permitted). | | `IdempotencyKey` | string | No | — | A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated. | | `Method` | string | No | — | The HTTP method Twilio will use when requesting the above `Url`. Either `GET` or `POST`. Default is `POST`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the User Defined Messages subscription is associated with. This refers to the Call SID that is producing the user defined messages." }, "Callback": { "type": "string", "description": "The URL we should call using the `method` to send user defined events to your application. URLs must contain a valid hostname (underscores are not permitted)." }, "IdempotencyKey": { "type": "string", "description": "A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated." }, "Method": { "type": "string", "description": "The HTTP method Twilio will use when requesting the above `Url`. Either `GET` or `POST`. Default is `POST`.", "enum": [ "GET", "POST" ] } }, "required": [ "PCID", "CallSid", "Callback" ] } ``` *** ## twilio\_voice\_delete\_call Delete a Call record from your account. Once the record is deleted, it will no longer appear in the API and Account Portal logs. **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------------------------------------------------------- | | `Sid` | string | Yes | — | The Twilio-provided Call SID that uniquely identifies the Call resource to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "Sid": { "type": "string", "description": "The Twilio-provided Call SID that uniquely identifies the Call resource to delete" } }, "required": [ "PCID", "Sid" ] } ``` *** ## twilio\_voice\_delete\_call\_recording Delete a recording from your account **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------- | | `CallSid` | string | Yes | — | The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to delete. | | `Sid` | string | Yes | — | The Twilio-provided string that uniquely identifies the Recording resource to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to delete." }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the Recording resource to delete." } }, "required": [ "PCID", "CallSid", "Sid" ] } ``` *** ## twilio\_voice\_delete\_conference\_recording Delete a recording from your account **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------ | | `ConferenceSid` | string | Yes | — | The Conference SID that identifies the conference associated with the recording to delete. | | `Sid` | string | Yes | — | The Twilio-provided string that uniquely identifies the Conference Recording resource to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ConferenceSid": { "type": "string", "description": "The Conference SID that identifies the conference associated with the recording to delete." }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the Conference Recording resource to delete." } }, "required": [ "PCID", "ConferenceSid", "Sid" ] } ``` *** ## twilio\_voice\_delete\_participant Kick a participant from a given conference **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ConferenceSid` | string | Yes | — | The SID of the conference with the participants to delete. | | `CallSid` | string | Yes | — | The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to delete. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ConferenceSid": { "type": "string", "description": "The SID of the conference with the participants to delete." }, "CallSid": { "type": "string", "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to delete. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20." } }, "required": [ "PCID", "ConferenceSid", "CallSid" ] } ``` *** ## twilio\_voice\_delete\_queue Remove an empty queue **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------------------------------------------------------------------------- | | `Sid` | string | Yes | — | The Twilio-provided string that uniquely identifies the Queue resource to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the Queue resource to delete" } }, "required": [ "PCID", "Sid" ] } ``` *** ## twilio\_voice\_delete\_user\_defined\_message\_subscription Delete a specific User Defined Message Subscription. **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `CallSid` | string | Yes | — | The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the User Defined Message Subscription is associated with. This refers to the Call SID that is producing the User Defined Messages. | | `Sid` | string | Yes | — | The SID that uniquely identifies this User Defined Message Subscription. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the User Defined Message Subscription is associated with. This refers to the Call SID that is producing the User Defined Messages." }, "Sid": { "type": "string", "description": "The SID that uniquely identifies this User Defined Message Subscription." } }, "required": [ "PCID", "CallSid", "Sid" ] } ``` *** ## twilio\_voice\_fetch\_call Fetch the call specified by the provided Call SID **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------------------------------- | | `Sid` | string | Yes | — | The SID of the Call resource to fetch. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "Sid": { "type": "string", "description": "The SID of the Call resource to fetch." } }, "required": [ "PCID", "Sid" ] } ``` *** ## twilio\_voice\_fetch\_call\_notification GET /Calls/\{CallSid}/Notifications/\{Sid}.json **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------- | | `CallSid` | string | Yes | — | The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the Call Notification resource to fetch. | | `Sid` | string | Yes | — | The Twilio-provided string that uniquely identifies the Call Notification resource to fetch. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the Call Notification resource to fetch." }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the Call Notification resource to fetch." } }, "required": [ "PCID", "CallSid", "Sid" ] } ``` *** ## twilio\_voice\_fetch\_call\_recording Fetch an instance of a recording for a call **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------- | | `CallSid` | string | Yes | — | The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource to fetch. | | `Sid` | string | Yes | — | The Twilio-provided string that uniquely identifies the Recording resource to fetch. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource to fetch." }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the Recording resource to fetch." } }, "required": [ "PCID", "CallSid", "Sid" ] } ``` *** ## twilio\_voice\_fetch\_conference Fetch an instance of a conference **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------ | | `Sid` | string | Yes | — | The Twilio-provided string that uniquely identifies the Conference resource to fetch | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the Conference resource to fetch" } }, "required": [ "PCID", "Sid" ] } ``` *** ## twilio\_voice\_fetch\_conference\_recording Fetch an instance of a recording for a call **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------- | | `ConferenceSid` | string | Yes | — | The Conference SID that identifies the conference associated with the recording to fetch. | | `Sid` | string | Yes | — | The Twilio-provided string that uniquely identifies the Conference Recording resource to fetch. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ConferenceSid": { "type": "string", "description": "The Conference SID that identifies the conference associated with the recording to fetch." }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the Conference Recording resource to fetch." } }, "required": [ "PCID", "ConferenceSid", "Sid" ] } ``` *** ## twilio\_voice\_fetch\_member Fetch a specific member from the queue **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------ | | `QueueSid` | string | Yes | — | The SID of the Queue in which to find the members to fetch. | | `CallSid` | string | Yes | — | The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource(s) to fetch. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "QueueSid": { "type": "string", "description": "The SID of the Queue in which to find the members to fetch." }, "CallSid": { "type": "string", "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource(s) to fetch." } }, "required": [ "PCID", "QueueSid", "CallSid" ] } ``` *** ## twilio\_voice\_fetch\_participant Fetch an instance of a participant **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ConferenceSid` | string | Yes | — | The SID of the conference with the participant to fetch. | | `CallSid` | string | Yes | — | The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to fetch. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ConferenceSid": { "type": "string", "description": "The SID of the conference with the participant to fetch." }, "CallSid": { "type": "string", "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to fetch. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20." } }, "required": [ "PCID", "ConferenceSid", "CallSid" ] } ``` *** ## twilio\_voice\_fetch\_queue Fetch an instance of a queue identified by the QueueSid **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------- | | `Sid` | string | Yes | — | The Twilio-provided string that uniquely identifies the Queue resource to fetch | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the Queue resource to fetch" } }, "required": [ "PCID", "Sid" ] } ``` *** ## twilio\_voice\_list\_call Retrieves a collection of calls made to and from your account **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `To` | string | No | — | Only show calls made to this phone number, SIP address, Client identifier or SIM SID. | | `From` | string | No | — | Only include calls from this phone number, SIP address, Client identifier or SIM SID. | | `ParentCallSid` | string | No | — | Only include calls spawned by calls with this SID. | | `Status` | string | No | — | The status of the calls to include. Can be: `queued`, `ringing`, `in-progress`, `canceled`, `completed`, `failed`, `busy`, or `no-answer`. | | `StartTime` | string | No | — | Only include calls that started on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that started on this date. | | `StartTime<` | string | No | — | Only include calls that started before this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that started before this date. | | `StartTime>` | string | No | — | Only include calls that started on or after this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that started on or after this date. | | `EndTime` | string | No | — | Only include calls that ended on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that ended on this date. | | `EndTime<` | string | No | — | Only include calls that ended before this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that ended before this date. | | `EndTime>` | string | No | — | Only include calls that ended on or after this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that ended on or after this date. | | `PageSize` | integer | No | — | How many resources to return in each list page. The default is 50, and the maximum is 1000. | | `Page` | integer | No | — | The page index. This value is simply for client state. | | `PageToken` | string | No | — | The page token. This is provided by the API. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "To": { "type": "string", "description": "Only show calls made to this phone number, SIP address, Client identifier or SIM SID." }, "From": { "type": "string", "description": "Only include calls from this phone number, SIP address, Client identifier or SIM SID." }, "ParentCallSid": { "type": "string", "description": "Only include calls spawned by calls with this SID." }, "Status": { "type": "string", "description": "The status of the calls to include. Can be: `queued`, `ringing`, `in-progress`, `canceled`, `completed`, `failed`, `busy`, or `no-answer`.", "enum": [ "queued", "ringing", "in-progress", "completed", "busy", "failed", "no-answer", "canceled" ] }, "StartTime": { "type": "string", "description": "Only include calls that started on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that started on this date." }, "StartTime<": { "type": "string", "description": "Only include calls that started before this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that started before this date." }, "StartTime>": { "type": "string", "description": "Only include calls that started on or after this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that started on or after this date." }, "EndTime": { "type": "string", "description": "Only include calls that ended on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that ended on this date." }, "EndTime<": { "type": "string", "description": "Only include calls that ended before this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that ended before this date." }, "EndTime>": { "type": "string", "description": "Only include calls that ended on or after this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that ended on or after this date." }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID" ] } ``` *** ## twilio\_voice\_list\_call\_notification GET /Calls/\{CallSid}/Notifications.json **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `CallSid` | string | Yes | — | The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the Call Notification resources to read. | | `Log` | integer | No | — | Only read notifications of the specified log level. Can be: `0` to read only ERROR notifications or `1` to read only WARNING notifications. By default, all notifications are read. | | `MessageDate` | string | No | — | Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date. | | `MessageDate<` | string | No | — | Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date. | | `MessageDate>` | string | No | — | Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date. | | `PageSize` | integer | No | — | How many resources to return in each list page. The default is 50, and the maximum is 1000. | | `Page` | integer | No | — | The page index. This value is simply for client state. | | `PageToken` | string | No | — | The page token. This is provided by the API. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the Call Notification resources to read." }, "Log": { "type": "integer", "description": "Only read notifications of the specified log level. Can be: `0` to read only ERROR notifications or `1` to read only WARNING notifications. By default, all notifications are read." }, "MessageDate": { "type": "string", "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date." }, "MessageDate<": { "type": "string", "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date." }, "MessageDate>": { "type": "string", "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date." }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID", "CallSid" ] } ``` *** ## twilio\_voice\_list\_call\_recording Retrieve a list of recordings belonging to the call used to make the request **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `CallSid` | string | Yes | — | The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to read. | | `DateCreated` | string | No | — | The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date. | | `DateCreated<` | string | No | — | The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date. | | `DateCreated>` | string | No | — | The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date. | | `PageSize` | integer | No | — | How many resources to return in each list page. The default is 50, and the maximum is 1000. | | `Page` | integer | No | — | The page index. This value is simply for client state. | | `PageToken` | string | No | — | The page token. This is provided by the API. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to read." }, "DateCreated": { "type": "string", "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date." }, "DateCreated<": { "type": "string", "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date." }, "DateCreated>": { "type": "string", "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date." }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID", "CallSid" ] } ``` *** ## twilio\_voice\_list\_conference Retrieve a list of conferences belonging to the account used to make the request **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `DateCreated` | string | No | — | Only include conferences that were created on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read conferences that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read conferences that were created on or after midnight of this date. | | `DateCreated<` | string | No | — | Only include conferences that were created on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read conferences that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read conferences that were created on or after midnight of this date. | | `DateCreated>` | string | No | — | Only include conferences that were created on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read conferences that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read conferences that were created on or after midnight of this date. | | `DateUpdated` | string | No | — | Only include conferences that were last updated on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were last updated on this date. You can also specify an inequality, such as `DateUpdated<=YYYY-MM-DD`, to read conferences that were last updated on or before midnight of this date, and `DateUpdated>=YYYY-MM-DD` to read conferences that were last updated on or after midnight of this date. | | `DateUpdated<` | string | No | — | Only include conferences that were last updated on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were last updated on this date. You can also specify an inequality, such as `DateUpdated<=YYYY-MM-DD`, to read conferences that were last updated on or before midnight of this date, and `DateUpdated>=YYYY-MM-DD` to read conferences that were last updated on or after midnight of this date. | | `DateUpdated>` | string | No | — | Only include conferences that were last updated on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were last updated on this date. You can also specify an inequality, such as `DateUpdated<=YYYY-MM-DD`, to read conferences that were last updated on or before midnight of this date, and `DateUpdated>=YYYY-MM-DD` to read conferences that were last updated on or after midnight of this date. | | `FriendlyName` | string | No | — | The string that identifies the Conference resources to read. | | `Status` | string | No | — | The status of the resources to read. Can be: `init`, `in-progress`, or `completed`. | | `PageSize` | integer | No | — | How many resources to return in each list page. The default is 50, and the maximum is 1000. | | `Page` | integer | No | — | The page index. This value is simply for client state. | | `PageToken` | string | No | — | The page token. This is provided by the API. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DateCreated": { "type": "string", "description": "Only include conferences that were created on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read conferences that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read conferences that were created on or after midnight of this date." }, "DateCreated<": { "type": "string", "description": "Only include conferences that were created on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read conferences that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read conferences that were created on or after midnight of this date." }, "DateCreated>": { "type": "string", "description": "Only include conferences that were created on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read conferences that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read conferences that were created on or after midnight of this date." }, "DateUpdated": { "type": "string", "description": "Only include conferences that were last updated on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were last updated on this date. You can also specify an inequality, such as `DateUpdated<=YYYY-MM-DD`, to read conferences that were last updated on or before midnight of this date, and `DateUpdated>=YYYY-MM-DD` to read conferences that were last updated on or after midnight of this date." }, "DateUpdated<": { "type": "string", "description": "Only include conferences that were last updated on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were last updated on this date. You can also specify an inequality, such as `DateUpdated<=YYYY-MM-DD`, to read conferences that were last updated on or before midnight of this date, and `DateUpdated>=YYYY-MM-DD` to read conferences that were last updated on or after midnight of this date." }, "DateUpdated>": { "type": "string", "description": "Only include conferences that were last updated on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were last updated on this date. You can also specify an inequality, such as `DateUpdated<=YYYY-MM-DD`, to read conferences that were last updated on or before midnight of this date, and `DateUpdated>=YYYY-MM-DD` to read conferences that were last updated on or after midnight of this date." }, "FriendlyName": { "type": "string", "description": "The string that identifies the Conference resources to read." }, "Status": { "type": "string", "description": "The status of the resources to read. Can be: `init`, `in-progress`, or `completed`.", "enum": [ "init", "in-progress", "completed" ] }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID" ] } ``` *** ## twilio\_voice\_list\_conference\_recording Retrieve a list of recordings belonging to the call used to make the request **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `ConferenceSid` | string | Yes | — | The Conference SID that identifies the conference associated with the recording to read. | | `DateCreated` | string | No | — | The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date. | | `DateCreated<` | string | No | — | The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date. | | `DateCreated>` | string | No | — | The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date. | | `PageSize` | integer | No | — | How many resources to return in each list page. The default is 50, and the maximum is 1000. | | `Page` | integer | No | — | The page index. This value is simply for client state. | | `PageToken` | string | No | — | The page token. This is provided by the API. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ConferenceSid": { "type": "string", "description": "The Conference SID that identifies the conference associated with the recording to read." }, "DateCreated": { "type": "string", "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date." }, "DateCreated<": { "type": "string", "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date." }, "DateCreated>": { "type": "string", "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date." }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID", "ConferenceSid" ] } ``` *** ## twilio\_voice\_list\_member Retrieve the members of the queue **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------- | | `QueueSid` | string | Yes | — | The SID of the Queue in which to find the members | | `PageSize` | integer | No | — | How many resources to return in each list page. The default is 50, and the maximum is 1000. | | `Page` | integer | No | — | The page index. This value is simply for client state. | | `PageToken` | string | No | — | The page token. This is provided by the API. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "QueueSid": { "type": "string", "description": "The SID of the Queue in which to find the members" }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID", "QueueSid" ] } ``` *** ## twilio\_voice\_list\_participant Retrieve a list of participants belonging to the account used to make the request **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------- | | `ConferenceSid` | string | Yes | — | The SID of the conference with the participants to read. | | `Muted` | boolean | No | — | Whether to return only participants that are muted. Can be: `true` or `false`. | | `Hold` | boolean | No | — | Whether to return only participants that are on hold. Can be: `true` or `false`. | | `Coaching` | boolean | No | — | Whether to return only participants who are coaching another call. Can be: `true` or `false`. | | `PageSize` | integer | No | — | How many resources to return in each list page. The default is 50, and the maximum is 1000. | | `Page` | integer | No | — | The page index. This value is simply for client state. | | `PageToken` | string | No | — | The page token. This is provided by the API. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ConferenceSid": { "type": "string", "description": "The SID of the conference with the participants to read." }, "Muted": { "type": "boolean", "description": "Whether to return only participants that are muted. Can be: `true` or `false`." }, "Hold": { "type": "boolean", "description": "Whether to return only participants that are on hold. Can be: `true` or `false`." }, "Coaching": { "type": "boolean", "description": "Whether to return only participants who are coaching another call. Can be: `true` or `false`." }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID", "ConferenceSid" ] } ``` *** ## twilio\_voice\_list\_queue Retrieve a list of queues belonging to the account used to make the request **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------- | | `PageSize` | integer | No | — | How many resources to return in each list page. The default is 50, and the maximum is 1000. | | `Page` | integer | No | — | The page index. This value is simply for client state. | | `PageToken` | string | No | — | The page token. This is provided by the API. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID" ] } ``` *** ## twilio\_voice\_list\_usage\_record Retrieve a list of usage-records belonging to the account used to make the request **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `Category` | string | No | — | The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. | | `StartDate` | string | No | — | Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date. | | `EndDate` | string | No | — | Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date. | | `IncludeSubaccounts` | boolean | No | — | Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account. | | `PageSize` | integer | No | — | How many resources to return in each list page. The default is 50, and the maximum is 1000. | | `Page` | integer | No | — | The page index. This value is simply for client state. | | `PageToken` | string | No | — | The page token. This is provided by the API. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "Category": { "type": "string", "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved." }, "StartDate": { "type": "string", "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date." }, "EndDate": { "type": "string", "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date." }, "IncludeSubaccounts": { "type": "boolean", "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account." }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID" ] } ``` *** ## twilio\_voice\_update\_call Initiates a call redirect or terminates a call **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Sid` | string | Yes | — | The Twilio-provided string that uniquely identifies the Call resource to update | | `FallbackMethod` | string | No | — | The HTTP method that we should use to request the `fallback_url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored. | | `FallbackUrl` | string | No | — | The URL that we call using the `fallback_method` if an error occurs when requesting or executing the TwiML at `url`. If an `application_sid` parameter is present, this parameter is ignored. | | `Method` | string | No | — | The HTTP method we should use when calling the `url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored. | | `Status` | string | No | — | The status value | | `StatusCallback` | string | No | — | The URL we should call using the `status_callback_method` to send status information to your application. If no `status_callback_event` is specified, we will send the `completed` status. If an `application_sid` parameter is present, this parameter is ignored. URLs must contain a valid hostname (underscores are not permitted). | | `StatusCallbackMethod` | string | No | — | The HTTP method we should use when requesting the `status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored. | | `TimeLimit` | integer | No | — | The maximum duration of the call in seconds. Constraints depend on account and configuration. | | `Twiml` | string | No | — | TwiML instructions for the call Twilio will use without fetching Twiml from url. Twiml and url parameters are mutually exclusive | | `Url` | string | No | — | The absolute URL that returns the TwiML instructions for the call. We will call this URL using the `method` when the call connects. For more information, see the [Url Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](https://www.twilio.com/docs/voice/make-calls). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the Call resource to update" }, "FallbackMethod": { "type": "string", "description": "The HTTP method that we should use to request the `fallback_url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", "enum": [ "GET", "POST" ] }, "FallbackUrl": { "type": "string", "description": "The URL that we call using the `fallback_method` if an error occurs when requesting or executing the TwiML at `url`. If an `application_sid` parameter is present, this parameter is ignored." }, "Method": { "type": "string", "description": "The HTTP method we should use when calling the `url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", "enum": [ "GET", "POST" ] }, "Status": { "type": "string", "description": "The status value", "enum": [ "canceled", "completed" ] }, "StatusCallback": { "type": "string", "description": "The URL we should call using the `status_callback_method` to send status information to your application. If no `status_callback_event` is specified, we will send the `completed` status. If an `application_sid` parameter is present, this parameter is ignored. URLs must contain a valid hostname (underscores are not permitted)." }, "StatusCallbackMethod": { "type": "string", "description": "The HTTP method we should use when requesting the `status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", "enum": [ "GET", "POST" ] }, "TimeLimit": { "type": "integer", "description": "The maximum duration of the call in seconds. Constraints depend on account and configuration." }, "Twiml": { "type": "string", "description": "TwiML instructions for the call Twilio will use without fetching Twiml from url. Twiml and url parameters are mutually exclusive" }, "Url": { "type": "string", "description": "The absolute URL that returns the TwiML instructions for the call. We will call this URL using the `method` when the call connects. For more information, see the [Url Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](https://www.twilio.com/docs/voice/make-calls)." } }, "required": [ "PCID", "Sid" ] } ``` *** ## twilio\_voice\_update\_call\_recording Changes the status of the recording to paused, stopped, or in-progress. Note: Pass `Twilio.CURRENT` instead of recording sid to reference current active recording. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `CallSid` | string | Yes | — | The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource to update. | | `Sid` | string | Yes | — | The Twilio-provided string that uniquely identifies the Recording resource to update. | | `PauseBehavior` | string | No | — | Whether to record during a pause. Can be: `skip` or `silence` and the default is `silence`. `skip` does not record during the pause period, while `silence` will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting `status` is set to `paused`. | | `Status` | string | Yes | — | The status of the recording. Can be: `processing`, `completed` and `absent`. For more detailed statuses on in-progress recordings, check out how to [Update a Recording Resource](https://www.twilio.com/docs/voice/api/recording#update-a-recording-resource). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource to update." }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the Recording resource to update." }, "PauseBehavior": { "type": "string", "description": "Whether to record during a pause. Can be: `skip` or `silence` and the default is `silence`. `skip` does not record during the pause period, while `silence` will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting `status` is set to `paused`." }, "Status": { "type": "string", "description": "The status of the recording. Can be: `processing`, `completed` and `absent`. For more detailed statuses on in-progress recordings, check out how to [Update a Recording Resource](https://www.twilio.com/docs/voice/api/recording#update-a-recording-resource).", "enum": [ "in-progress", "paused", "stopped", "processing", "completed", "absent" ] } }, "required": [ "PCID", "CallSid", "Sid", "Status" ] } ``` *** ## twilio\_voice\_update\_conference POST /Conferences/\{Sid}.json **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Sid` | string | Yes | — | The Twilio-provided string that uniquely identifies the Conference resource to update | | `AnnounceMethod` | string | No | — | The HTTP method used to call `announce_url`. Can be: `GET` or `POST` and the default is `POST` | | `AnnounceUrl` | string | No | — | The URL we should call to announce something into the conference. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs. | | `Status` | string | No | — | The status value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the Conference resource to update" }, "AnnounceMethod": { "type": "string", "description": "The HTTP method used to call `announce_url`. Can be: `GET` or `POST` and the default is `POST`", "enum": [ "GET", "POST" ] }, "AnnounceUrl": { "type": "string", "description": "The URL we should call to announce something into the conference. The URL may return an MP3 file, a WAV file, or a TwiML document that contains ``, ``, ``, or `` verbs." }, "Status": { "type": "string", "description": "The status value", "enum": [ "completed" ] } }, "required": [ "PCID", "Sid" ] } ``` *** ## twilio\_voice\_update\_conference\_recording Changes the status of the recording to paused, stopped, or in-progress. Note: To use `Twilio.CURRENT`, pass it as recording sid. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ConferenceSid` | string | Yes | — | The Conference SID that identifies the conference associated with the recording to update. | | `Sid` | string | Yes | — | The Twilio-provided string that uniquely identifies the Conference Recording resource to update. Use `Twilio.CURRENT` to reference the current active recording. | | `PauseBehavior` | string | No | — | Whether to record during a pause. Can be: `skip` or `silence` and the default is `silence`. `skip` does not record during the pause period, while `silence` will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting `status` is set to `paused`. | | `Status` | string | Yes | — | The status of the recording. Can be: `processing`, `completed` and `absent`. For more detailed statuses on in-progress recordings, check out how to [Update a Recording Resource](https://www.twilio.com/docs/voice/api/recording#update-a-recording-resource). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ConferenceSid": { "type": "string", "description": "The Conference SID that identifies the conference associated with the recording to update." }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the Conference Recording resource to update. Use `Twilio.CURRENT` to reference the current active recording." }, "PauseBehavior": { "type": "string", "description": "Whether to record during a pause. Can be: `skip` or `silence` and the default is `silence`. `skip` does not record during the pause period, while `silence` will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting `status` is set to `paused`." }, "Status": { "type": "string", "description": "The status of the recording. Can be: `processing`, `completed` and `absent`. For more detailed statuses on in-progress recordings, check out how to [Update a Recording Resource](https://www.twilio.com/docs/voice/api/recording#update-a-recording-resource).", "enum": [ "in-progress", "paused", "stopped", "processing", "completed", "absent" ] } }, "required": [ "PCID", "ConferenceSid", "Sid", "Status" ] } ``` *** ## twilio\_voice\_update\_member Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `QueueSid` | string | Yes | — | The SID of the Queue in which to find the members to update. | | `CallSid` | string | Yes | — | The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource(s) to update. | | `Method` | string | No | — | How to pass the update request data. Can be `GET` or `POST` and the default is `POST`. `POST` sends the data as encoded form data and `GET` sends the data as query parameters. | | `Url` | string | Yes | — | The absolute URL of the Queue resource. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "QueueSid": { "type": "string", "description": "The SID of the Queue in which to find the members to update." }, "CallSid": { "type": "string", "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource(s) to update." }, "Method": { "type": "string", "description": "How to pass the update request data. Can be `GET` or `POST` and the default is `POST`. `POST` sends the data as encoded form data and `GET` sends the data as query parameters.", "enum": [ "GET", "POST" ] }, "Url": { "type": "string", "description": "The absolute URL of the Queue resource." } }, "required": [ "PCID", "QueueSid", "CallSid", "Url" ] } ``` *** ## twilio\_voice\_update\_participant Update the properties of the participant **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ConferenceSid` | string | Yes | — | The SID of the conference with the participant to update. | | `CallSid` | string | Yes | — | The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to update. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20. | | `AnnounceMethod` | string | No | — | The HTTP method we should use to call `announce_url`. Can be: `GET` or `POST` and defaults to `POST`. | | `AnnounceUrl` | string | No | — | The URL we call using the `announce_method` for an announcement to the participant. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs. | | `BeepOnExit` | boolean | No | — | Whether to play a notification beep to the conference when the participant exits. Can be: `true` or `false`. | | `CallSidToCoach` | string | No | — | The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`. | | `Coaching` | boolean | No | — | Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined. | | `EndConferenceOnExit` | boolean | No | — | Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`. | | `Hold` | boolean | No | — | Whether the participant should be on hold. Can be: `true` or `false`. `true` puts the participant on hold, and `false` lets them rejoin the conference. | | `HoldMethod` | string | No | — | The HTTP method we should use to call `hold_url`. Can be: `GET` or `POST` and the default is `GET`. | | `HoldUrl` | string | No | — | The URL we call using the `hold_method` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs. | | `Muted` | boolean | No | — | Whether the participant should be muted. Can be `true` or `false`. `true` will mute the participant, and `false` will un-mute them. Anything value other than `true` or `false` is interpreted as `false`. | | `WaitMethod` | string | No | — | The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file. | | `WaitUrl` | string | No | — | The URL that Twilio calls using the `wait_method` before the conference has started. The URL may return an MP3 file, a WAV file, or a TwiML document. The default value is the URL of our standard hold music. If you do not want anything to play while waiting for the conference to start, specify an empty string by setting `wait_url` to `''`. For more details on the allowable verbs within the `waitUrl`, see the `waitUrl` attribute in the [\ TwiML instruction](https://www.twilio.com/docs/voice/twiml/conference#attributes-waiturl). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ConferenceSid": { "type": "string", "description": "The SID of the conference with the participant to update." }, "CallSid": { "type": "string", "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to update. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20." }, "AnnounceMethod": { "type": "string", "description": "The HTTP method we should use to call `announce_url`. Can be: `GET` or `POST` and defaults to `POST`.", "enum": [ "GET", "POST" ] }, "AnnounceUrl": { "type": "string", "description": "The URL we call using the `announce_method` for an announcement to the participant. The URL may return an MP3 file, a WAV file, or a TwiML document that contains ``, ``, ``, or `` verbs." }, "BeepOnExit": { "type": "boolean", "description": "Whether to play a notification beep to the conference when the participant exits. Can be: `true` or `false`." }, "CallSidToCoach": { "type": "string", "description": "The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`." }, "Coaching": { "type": "boolean", "description": "Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined." }, "EndConferenceOnExit": { "type": "boolean", "description": "Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`." }, "Hold": { "type": "boolean", "description": "Whether the participant should be on hold. Can be: `true` or `false`. `true` puts the participant on hold, and `false` lets them rejoin the conference." }, "HoldMethod": { "type": "string", "description": "The HTTP method we should use to call `hold_url`. Can be: `GET` or `POST` and the default is `GET`.", "enum": [ "GET", "POST" ] }, "HoldUrl": { "type": "string", "description": "The URL we call using the `hold_method` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains ``, ``, ``, or `` verbs." }, "Muted": { "type": "boolean", "description": "Whether the participant should be muted. Can be `true` or `false`. `true` will mute the participant, and `false` will un-mute them. Anything value other than `true` or `false` is interpreted as `false`." }, "WaitMethod": { "type": "string", "description": "The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.", "enum": [ "GET", "POST" ] }, "WaitUrl": { "type": "string", "description": "The URL that Twilio calls using the `wait_method` before the conference has started. The URL may return an MP3 file, a WAV file, or a TwiML document. The default value is the URL of our standard hold music. If you do not want anything to play while waiting for the conference to start, specify an empty string by setting `wait_url` to `''`. For more details on the allowable verbs within the `waitUrl`, see the `waitUrl` attribute in the [ TwiML instruction](https://www.twilio.com/docs/voice/twiml/conference#attributes-waiturl)." } }, "required": [ "PCID", "ConferenceSid", "CallSid" ] } ``` *** ## twilio\_voice\_update\_payments update an instance of payments with different phases of payment flows. **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `CallSid` | string | Yes | — | The SID of the call that will update the resource. This should be the same call sid that was used to create payments resource. | | `Sid` | string | Yes | — | The SID of Payments session that needs to be updated. | | `Capture` | string | No | — | The piece of payment information that you wish the caller to enter. Must be one of `payment-card-number`, `expiration-date`, `security-code`, `postal-code`, `bank-routing-number`, `bank-account-number`, or their `-matcher` variants for input confirmation when `RequireMatchingInputs` is enabled. | | `IdempotencyKey` | string | Yes | — | A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated. | | `Status` | string | No | — | Indicates whether the current payment session should be cancelled or completed. When `cancel` the payment session is cancelled. When `complete`, Twilio sends the payment information to the selected Pay Connector for processing. | | `StatusCallback` | string | Yes | — | Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [Update](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-update) and [Complete/Cancel](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-cancelcomplete) POST requests. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The SID of the call that will update the resource. This should be the same call sid that was used to create payments resource." }, "Sid": { "type": "string", "description": "The SID of Payments session that needs to be updated." }, "Capture": { "type": "string", "description": "The piece of payment information that you wish the caller to enter. Must be one of `payment-card-number`, `expiration-date`, `security-code`, `postal-code`, `bank-routing-number`, `bank-account-number`, or their `-matcher` variants for input confirmation when `RequireMatchingInputs` is enabled.", "enum": [ "payment-card-number", "expiration-date", "security-code", "postal-code", "bank-routing-number", "bank-account-number", "payment-card-number-matcher", "expiration-date-matcher", "security-code-matcher", "postal-code-matcher" ] }, "IdempotencyKey": { "type": "string", "description": "A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated." }, "Status": { "type": "string", "description": "Indicates whether the current payment session should be cancelled or completed. When `cancel` the payment session is cancelled. When `complete`, Twilio sends the payment information to the selected Pay Connector for processing.", "enum": [ "complete", "cancel" ] }, "StatusCallback": { "type": "string", "description": "Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [Update](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-update) and [Complete/Cancel](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-cancelcomplete) POST requests." } }, "required": [ "PCID", "CallSid", "Sid", "IdempotencyKey", "StatusCallback" ] } ``` *** ## twilio\_voice\_update\_queue Update the queue with the new parameters **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------- | | `Sid` | string | Yes | — | The Twilio-provided string that uniquely identifies the Queue resource to update | | `FriendlyName` | string | No | — | A descriptive string that you created to describe this resource. It can be up to 64 characters long. | | `MaxSize` | integer | No | — | The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the Queue resource to update" }, "FriendlyName": { "type": "string", "description": "A descriptive string that you created to describe this resource. It can be up to 64 characters long." }, "MaxSize": { "type": "integer", "description": "The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000." } }, "required": [ "PCID", "Sid" ] } ``` *** ## twilio\_voice\_update\_realtime\_transcription Stop a Transcription using either the SID of the Transcription resource or the `name` used when creating the resource **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------- | | `CallSid` | string | Yes | — | The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Transcription resource is associated with. | | `Sid` | string | Yes | — | The SID of the Transcription resource, or the `name` used when creating the resource | | `Status` | string | Yes | — | The status value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Transcription resource is associated with." }, "Sid": { "type": "string", "description": "The SID of the Transcription resource, or the `name` used when creating the resource" }, "Status": { "type": "string", "description": "The status value", "enum": [ "stopped" ] } }, "required": [ "PCID", "CallSid", "Sid", "Status" ] } ``` *** ## twilio\_voice\_update\_siprec Stop a Siprec using either the SID of the Siprec resource or the `name` used when creating the resource **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------ | | `CallSid` | string | Yes | — | The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Siprec resource is associated with. | | `Sid` | string | Yes | — | The SID of the Siprec resource, or the `name` used when creating the resource | | `Status` | string | Yes | — | The status value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Siprec resource is associated with." }, "Sid": { "type": "string", "description": "The SID of the Siprec resource, or the `name` used when creating the resource" }, "Status": { "type": "string", "description": "The status value", "enum": [ "stopped" ] } }, "required": [ "PCID", "CallSid", "Sid", "Status" ] } ``` *** ## twilio\_voice\_update\_stream Stop a Stream using either the SID of the Stream resource or the `name` used when creating the resource **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------ | | `CallSid` | string | Yes | — | The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Stream resource is associated with. | | `Sid` | string | Yes | — | The SID or the `name` of the Stream resource to be stopped | | `Status` | string | Yes | — | The status value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CallSid": { "type": "string", "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Stream resource is associated with." }, "Sid": { "type": "string", "description": "The SID or the `name` of the Stream resource to be stopped" }, "Status": { "type": "string", "description": "The status value", "enum": [ "stopped" ] } }, "required": [ "PCID", "CallSid", "Sid", "Status" ] } ```