471 lines
14 KiB
Markdown
471 lines
14 KiB
Markdown
---
|
|
name: op-2010-04-01-3-routes
|
|
description: Handle 37 OpenAPI operation(s) under /2010-04-01/Accounts/{AccountSid} for the 2010 04 01 3 route group.
|
|
---
|
|
|
|
# 2010 04 01 3 API Routes
|
|
|
|
Handle 37 OpenAPI operation(s) under /2010-04-01/Accounts/{AccountSid} for the 2010 04 01 3 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
|
|
|
|
### fetch_sip_ip_access_control_list
|
|
|
|
- Operation ID: `fetch_sip_ip_access_control_list`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch a specific instance of an IpAccessControlList
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### update_sip_ip_access_control_list
|
|
|
|
- Operation ID: `update_sip_ip_access_control_list`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Rename an IpAccessControlList
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_sip_ip_access_control_list
|
|
|
|
- Operation ID: `delete_sip_ip_access_control_list`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete an IpAccessControlList from the requested account
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### fetch_sip_ip_access_control_list_mapping
|
|
|
|
- Operation ID: `fetch_sip_ip_access_control_list_mapping`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an IpAccessControlListMapping resource.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### delete_sip_ip_access_control_list_mapping
|
|
|
|
- Operation ID: `delete_sip_ip_access_control_list_mapping`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete an IpAccessControlListMapping resource.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### create_sip_ip_access_control_list_mapping
|
|
|
|
- Operation ID: `create_sip_ip_access_control_list_mapping`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a new IpAccessControlListMapping resource.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_sip_ip_access_control_list_mapping
|
|
|
|
- Operation ID: `list_sip_ip_access_control_list_mapping`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of IpAccessControlListMapping resources.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DomainSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_sip_ip_address
|
|
|
|
- Operation ID: `list_sip_ip_address`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses.json`
|
|
- Mode: READ
|
|
- Summary: Read multiple IpAddress resources.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `IpAccessControlListSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### create_sip_ip_address
|
|
|
|
- Operation ID: `create_sip_ip_address`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a new IpAddress resource.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `IpAccessControlListSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### fetch_sip_ip_address
|
|
|
|
- Operation ID: `fetch_sip_ip_address`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Read one IpAddress resource.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `IpAccessControlListSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### update_sip_ip_address
|
|
|
|
- Operation ID: `update_sip_ip_address`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Update an IpAddress resource.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `IpAccessControlListSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_sip_ip_address
|
|
|
|
- Operation ID: `delete_sip_ip_address`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete an IpAddress resource.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `IpAccessControlListSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### create_siprec
|
|
|
|
- Operation ID: `create_siprec`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Siprec.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a Siprec
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### update_siprec
|
|
|
|
- Operation ID: `update_siprec`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Siprec/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Stop a Siprec using either the SID of the Siprec 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.
|
|
|
|
### create_stream
|
|
|
|
- Operation ID: `create_stream`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Streams.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a Stream
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### update_stream
|
|
|
|
- Operation ID: `update_stream`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Streams/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Stop a Stream using either the SID of the Stream 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.
|
|
|
|
### create_token
|
|
|
|
- Operation ID: `create_token`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Tokens.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a new token for ICE servers
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### fetch_transcription
|
|
|
|
- Operation ID: `fetch_transcription`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Transcriptions/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an instance of a Transcription
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### delete_transcription
|
|
|
|
- Operation ID: `delete_transcription`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/Transcriptions/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete a transcription from the account used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_transcription
|
|
|
|
- Operation ID: `list_transcription`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Transcriptions.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of transcriptions belonging to the account used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_usage_record
|
|
|
|
- Operation ID: `list_usage_record`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Usage/Records.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of usage-records belonging to the account used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Category` in `query`
|
|
- `StartDate` in `query`
|
|
- `EndDate` in `query`
|
|
- `IncludeSubaccounts` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_usage_record_all_time
|
|
|
|
- Operation ID: `list_usage_record_all_time`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Usage/Records/AllTime.json`
|
|
- Mode: READ
|
|
- Summary: ListUsageRecordAllTime
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Category` in `query`
|
|
- `StartDate` in `query`
|
|
- `EndDate` in `query`
|
|
- `IncludeSubaccounts` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_usage_record_daily
|
|
|
|
- Operation ID: `list_usage_record_daily`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Usage/Records/Daily.json`
|
|
- Mode: READ
|
|
- Summary: ListUsageRecordDaily
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Category` in `query`
|
|
- `StartDate` in `query`
|
|
- `EndDate` in `query`
|
|
- `IncludeSubaccounts` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_usage_record_last_month
|
|
|
|
- Operation ID: `list_usage_record_last_month`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Usage/Records/LastMonth.json`
|
|
- Mode: READ
|
|
- Summary: ListUsageRecordLastMonth
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Category` in `query`
|
|
- `StartDate` in `query`
|
|
- `EndDate` in `query`
|
|
- `IncludeSubaccounts` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_usage_record_monthly
|
|
|
|
- Operation ID: `list_usage_record_monthly`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Usage/Records/Monthly.json`
|
|
- Mode: READ
|
|
- Summary: ListUsageRecordMonthly
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Category` in `query`
|
|
- `StartDate` in `query`
|
|
- `EndDate` in `query`
|
|
- `IncludeSubaccounts` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_usage_record_this_month
|
|
|
|
- Operation ID: `list_usage_record_this_month`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Usage/Records/ThisMonth.json`
|
|
- Mode: READ
|
|
- Summary: ListUsageRecordThisMonth
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Category` in `query`
|
|
- `StartDate` in `query`
|
|
- `EndDate` in `query`
|
|
- `IncludeSubaccounts` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_usage_record_today
|
|
|
|
- Operation ID: `list_usage_record_today`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Usage/Records/Today.json`
|
|
- Mode: READ
|
|
- Summary: ListUsageRecordToday
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Category` in `query`
|
|
- `StartDate` in `query`
|
|
- `EndDate` in `query`
|
|
- `IncludeSubaccounts` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_usage_record_yearly
|
|
|
|
- Operation ID: `list_usage_record_yearly`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Usage/Records/Yearly.json`
|
|
- Mode: READ
|
|
- Summary: ListUsageRecordYearly
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Category` in `query`
|
|
- `StartDate` in `query`
|
|
- `EndDate` in `query`
|
|
- `IncludeSubaccounts` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_usage_record_yesterday
|
|
|
|
- Operation ID: `list_usage_record_yesterday`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Usage/Records/Yesterday.json`
|
|
- Mode: READ
|
|
- Summary: ListUsageRecordYesterday
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Category` in `query`
|
|
- `StartDate` in `query`
|
|
- `EndDate` in `query`
|
|
- `IncludeSubaccounts` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### fetch_usage_trigger
|
|
|
|
- Operation ID: `fetch_usage_trigger`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Usage/Triggers/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch and instance of a usage-trigger
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### update_usage_trigger
|
|
|
|
- Operation ID: `update_usage_trigger`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Usage/Triggers/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Update an instance of a usage trigger
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_usage_trigger
|
|
|
|
- Operation ID: `delete_usage_trigger`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/Usage/Triggers/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: DeleteUsageTrigger
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### create_usage_trigger
|
|
|
|
- Operation ID: `create_usage_trigger`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Usage/Triggers.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a new UsageTrigger
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_usage_trigger
|
|
|
|
- Operation ID: `list_usage_trigger`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Usage/Triggers.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of usage-triggers belonging to the account used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Recurring` in `query`
|
|
- `TriggerBy` in `query`
|
|
- `UsageCategory` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### create_user_defined_message
|
|
|
|
- Operation ID: `create_user_defined_message`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/UserDefinedMessages.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a new User Defined Message for the given Call SID.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### create_user_defined_message_subscription
|
|
|
|
- Operation ID: `create_user_defined_message_subscription`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/UserDefinedMessageSubscriptions.json`
|
|
- Mode: WRITE
|
|
- Summary: Subscribe to User Defined Messages for a given Call SID.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_user_defined_message_subscription
|
|
|
|
- Operation ID: `delete_user_defined_message_subscription`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/UserDefinedMessageSubscriptions/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete a specific User Defined Message Subscription.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- `Sid` in `path` required
|