932 lines
29 KiB
Markdown
932 lines
29 KiB
Markdown
---
|
|
name: op-2010-04-01-2-routes
|
|
description: Handle 80 OpenAPI operation(s) under /2010-04-01/Accounts/{AccountSid} for the 2010 04 01 2 route group.
|
|
---
|
|
|
|
# 2010 04 01 2 API Routes
|
|
|
|
Handle 80 OpenAPI operation(s) under /2010-04-01/Accounts/{AccountSid} for the 2010 04 01 2 route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### list_message
|
|
|
|
- Operation ID: `list_message`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Messages.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of Message resources associated with a Twilio Account
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `To` in `query`
|
|
- `From` in `query`
|
|
- `DateSent` in `query`
|
|
- `DateSent<` in `query`
|
|
- `DateSent>` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### delete_message
|
|
|
|
- Operation ID: `delete_message`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Deletes a Message resource from your account
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### fetch_message
|
|
|
|
- Operation ID: `fetch_message`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch a specific Message
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### update_message
|
|
|
|
- Operation ID: `update_message`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Update a Message resource (used to redact Message `body` text and to cancel not-yet-sent messages)
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### create_message_feedback
|
|
|
|
- Operation ID: `create_message_feedback`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Feedback.json`
|
|
- Mode: WRITE
|
|
- Summary: Create Message Feedback to confirm a tracked user action was performed by the recipient of the associated Message
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `MessageSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### create_new_signing_key
|
|
|
|
- Operation ID: `create_new_signing_key`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SigningKeys.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a new Signing Key for the account making the request.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_signing_key
|
|
|
|
- Operation ID: `list_signing_key`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SigningKeys.json`
|
|
- Mode: READ
|
|
- Summary: ListSigningKey
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### fetch_notification
|
|
|
|
- Operation ID: `fetch_notification`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Notifications/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch a notification belonging to the account used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_notification
|
|
|
|
- Operation ID: `list_notification`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Notifications.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of notifications belonging to the account used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Log` in `query`
|
|
- `MessageDate` in `query`
|
|
- `MessageDate<` in `query`
|
|
- `MessageDate>` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### fetch_outgoing_caller_id
|
|
|
|
- Operation ID: `fetch_outgoing_caller_id`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an outgoing-caller-id belonging to the account used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### update_outgoing_caller_id
|
|
|
|
- Operation ID: `update_outgoing_caller_id`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Updates the caller-id
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_outgoing_caller_id
|
|
|
|
- Operation ID: `delete_outgoing_caller_id`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete the caller-id specified from the account
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_outgoing_caller_id
|
|
|
|
- Operation ID: `list_outgoing_caller_id`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of outgoing-caller-ids belonging to the account used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `PhoneNumber` in `query`
|
|
- `FriendlyName` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### create_validation_request
|
|
|
|
- Operation ID: `create_validation_request`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds.json`
|
|
- Mode: WRITE
|
|
- Summary: CreateValidationRequest
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### fetch_participant
|
|
|
|
- Operation ID: `fetch_participant`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an instance of a participant
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ConferenceSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
|
|
### update_participant
|
|
|
|
- Operation ID: `update_participant`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Update the properties of the participant
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ConferenceSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_participant
|
|
|
|
- Operation ID: `delete_participant`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Kick a participant from a given conference
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ConferenceSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
|
|
### create_participant
|
|
|
|
- Operation ID: `create_participant`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json`
|
|
- Mode: WRITE
|
|
- Summary: CreateParticipant
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ConferenceSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_participant
|
|
|
|
- Operation ID: `list_participant`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of participants belonging to the account used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ConferenceSid` in `path` required
|
|
- `Muted` in `query`
|
|
- `Hold` in `query`
|
|
- `Coaching` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### create_payments
|
|
|
|
- Operation ID: `create_payments`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments.json`
|
|
- Mode: WRITE
|
|
- Summary: create an instance of payments. This will start a new payments session
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### update_payments
|
|
|
|
- Operation ID: `update_payments`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: update an instance of payments with different phases of payment flows.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### fetch_queue
|
|
|
|
- Operation ID: `fetch_queue`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an instance of a queue identified by the QueueSid
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### update_queue
|
|
|
|
- Operation ID: `update_queue`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Update the queue with the new parameters
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_queue
|
|
|
|
- Operation ID: `delete_queue`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Remove an empty queue
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_queue
|
|
|
|
- Operation ID: `list_queue`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Queues.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of queues belonging to the account used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### create_queue
|
|
|
|
- Operation ID: `create_queue`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Queues.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a queue
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### create_realtime_transcription
|
|
|
|
- Operation ID: `create_realtime_transcription`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Transcriptions.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a Transcription
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### update_realtime_transcription
|
|
|
|
- Operation ID: `update_realtime_transcription`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Transcriptions/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Stop a Transcription using either the SID of the Transcription resource or the `name` used when creating the resource
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### fetch_recording
|
|
|
|
- Operation ID: `fetch_recording`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an instance of a recording
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- `IncludeSoftDeleted` in `query`
|
|
|
|
### delete_recording
|
|
|
|
- Operation ID: `delete_recording`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete a recording from your account
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_recording
|
|
|
|
- Operation ID: `list_recording`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Recordings.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of recordings belonging to the account used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DateCreated` in `query`
|
|
- `DateCreated<` in `query`
|
|
- `DateCreated>` in `query`
|
|
- `CallSid` in `query`
|
|
- `ConferenceSid` in `query`
|
|
- `IncludeSoftDeleted` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### fetch_recording_add_on_result
|
|
|
|
- Operation ID: `fetch_recording_add_on_result`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an instance of an AddOnResult
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ReferenceSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### delete_recording_add_on_result
|
|
|
|
- Operation ID: `delete_recording_add_on_result`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete a result and purge all associated Payloads
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ReferenceSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_recording_add_on_result
|
|
|
|
- Operation ID: `list_recording_add_on_result`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of results belonging to the recording
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ReferenceSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### fetch_recording_add_on_result_payload
|
|
|
|
- Operation ID: `fetch_recording_add_on_result_payload`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an instance of a result payload
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ReferenceSid` in `path` required
|
|
- `AddOnResultSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### delete_recording_add_on_result_payload
|
|
|
|
- Operation ID: `delete_recording_add_on_result_payload`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete a payload from the result along with all associated Data
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ReferenceSid` in `path` required
|
|
- `AddOnResultSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_recording_add_on_result_payload
|
|
|
|
- Operation ID: `list_recording_add_on_result_payload`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of payloads belonging to the AddOnResult
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ReferenceSid` in `path` required
|
|
- `AddOnResultSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### fetch_recording_add_on_result_payload_data
|
|
|
|
- Operation ID: `fetch_recording_add_on_result_payload_data`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{PayloadSid}/Data.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an instance of a result payload
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ReferenceSid` in `path` required
|
|
- `AddOnResultSid` in `path` required
|
|
- `PayloadSid` in `path` required
|
|
|
|
### fetch_recording_transcription
|
|
|
|
- Operation ID: `fetch_recording_transcription`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: FetchRecordingTranscription
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `RecordingSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### delete_recording_transcription
|
|
|
|
- Operation ID: `delete_recording_transcription`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: DeleteRecordingTranscription
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `RecordingSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_recording_transcription
|
|
|
|
- Operation ID: `list_recording_transcription`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions.json`
|
|
- Mode: READ
|
|
- Summary: ListRecordingTranscription
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `RecordingSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### fetch_short_code
|
|
|
|
- Operation ID: `fetch_short_code`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an instance of a short code
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### update_short_code
|
|
|
|
- Operation ID: `update_short_code`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Update a short code with the following parameters
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_short_code
|
|
|
|
- Operation ID: `list_short_code`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of short-codes belonging to the account used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `FriendlyName` in `query`
|
|
- `ShortCode` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### fetch_signing_key
|
|
|
|
- Operation ID: `fetch_signing_key`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SigningKeys/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: FetchSigningKey
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### update_signing_key
|
|
|
|
- Operation ID: `update_signing_key`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SigningKeys/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: UpdateSigningKey
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_signing_key
|
|
|
|
- Operation ID: `delete_signing_key`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/SigningKeys/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: DeleteSigningKey
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### create_sip_auth_calls_credential_list_mapping
|
|
|
|
- Operation ID: `create_sip_auth_calls_credential_list_mapping`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a new credential list mapping resource
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_sip_auth_calls_credential_list_mapping
|
|
|
|
- Operation ID: `list_sip_auth_calls_credential_list_mapping`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of credential list mappings belonging to the domain used in the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### fetch_sip_auth_calls_credential_list_mapping
|
|
|
|
- Operation ID: `fetch_sip_auth_calls_credential_list_mapping`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch a specific instance of a credential list mapping
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### delete_sip_auth_calls_credential_list_mapping
|
|
|
|
- Operation ID: `delete_sip_auth_calls_credential_list_mapping`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete a credential list mapping from the requested domain
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### create_sip_auth_calls_ip_access_control_list_mapping
|
|
|
|
- Operation ID: `create_sip_auth_calls_ip_access_control_list_mapping`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a new IP Access Control List mapping
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_sip_auth_calls_ip_access_control_list_mapping
|
|
|
|
- Operation ID: `list_sip_auth_calls_ip_access_control_list_mapping`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of IP Access Control List mappings belonging to the domain used in the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### fetch_sip_auth_calls_ip_access_control_list_mapping
|
|
|
|
- Operation ID: `fetch_sip_auth_calls_ip_access_control_list_mapping`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch a specific instance of an IP Access Control List mapping
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### delete_sip_auth_calls_ip_access_control_list_mapping
|
|
|
|
- Operation ID: `delete_sip_auth_calls_ip_access_control_list_mapping`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete an IP Access Control List mapping from the requested domain
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### create_sip_auth_registrations_credential_list_mapping
|
|
|
|
- Operation ID: `create_sip_auth_registrations_credential_list_mapping`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations/CredentialListMappings.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a new credential list mapping resource
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_sip_auth_registrations_credential_list_mapping
|
|
|
|
- Operation ID: `list_sip_auth_registrations_credential_list_mapping`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations/CredentialListMappings.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of credential list mappings belonging to the domain used in the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### fetch_sip_auth_registrations_credential_list_mapping
|
|
|
|
- Operation ID: `fetch_sip_auth_registrations_credential_list_mapping`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations/CredentialListMappings/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch a specific instance of a credential list mapping
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### delete_sip_auth_registrations_credential_list_mapping
|
|
|
|
- Operation ID: `delete_sip_auth_registrations_credential_list_mapping`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations/CredentialListMappings/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete a credential list mapping from the requested domain
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_sip_credential
|
|
|
|
- Operation ID: `list_sip_credential`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of credentials.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CredentialListSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### create_sip_credential
|
|
|
|
- Operation ID: `create_sip_credential`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a new credential resource.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CredentialListSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### fetch_sip_credential
|
|
|
|
- Operation ID: `fetch_sip_credential`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch a single credential.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CredentialListSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### update_sip_credential
|
|
|
|
- Operation ID: `update_sip_credential`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Update a credential resource.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CredentialListSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_sip_credential
|
|
|
|
- Operation ID: `delete_sip_credential`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete a credential resource.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CredentialListSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_sip_credential_list
|
|
|
|
- Operation ID: `list_sip_credential_list`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json`
|
|
- Mode: READ
|
|
- Summary: Get All Credential Lists
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### create_sip_credential_list
|
|
|
|
- Operation ID: `create_sip_credential_list`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a Credential List
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### fetch_sip_credential_list
|
|
|
|
- Operation ID: `fetch_sip_credential_list`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Get a Credential List
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### update_sip_credential_list
|
|
|
|
- Operation ID: `update_sip_credential_list`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Update a Credential List
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_sip_credential_list
|
|
|
|
- Operation ID: `delete_sip_credential_list`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete a Credential List
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### create_sip_credential_list_mapping
|
|
|
|
- Operation ID: `create_sip_credential_list_mapping`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a CredentialListMapping resource for an account.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_sip_credential_list_mapping
|
|
|
|
- Operation ID: `list_sip_credential_list_mapping`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings.json`
|
|
- Mode: READ
|
|
- Summary: Read multiple CredentialListMapping resources from an account.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### fetch_sip_credential_list_mapping
|
|
|
|
- Operation ID: `fetch_sip_credential_list_mapping`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch a single CredentialListMapping resource from an account.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### delete_sip_credential_list_mapping
|
|
|
|
- Operation ID: `delete_sip_credential_list_mapping`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete a CredentialListMapping resource from an account.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_sip_domain
|
|
|
|
- Operation ID: `list_sip_domain`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/Domains.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of domains belonging to the account used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### create_sip_domain
|
|
|
|
- Operation ID: `create_sip_domain`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SIP/Domains.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a new Domain
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### fetch_sip_domain
|
|
|
|
- Operation ID: `fetch_sip_domain`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an instance of a Domain
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### update_sip_domain
|
|
|
|
- Operation ID: `update_sip_domain`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Update the attributes of a domain
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_sip_domain
|
|
|
|
- Operation ID: `delete_sip_domain`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete an instance of a Domain
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_sip_ip_access_control_list
|
|
|
|
- Operation ID: `list_sip_ip_access_control_list`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of IpAccessControlLists that belong to the account used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### create_sip_ip_access_control_list
|
|
|
|
- Operation ID: `create_sip_ip_access_control_list`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a new IpAccessControlList resource
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- Body: JSON request body accepted.
|