1092 lines
32 KiB
Markdown
1092 lines
32 KiB
Markdown
---
|
|
name: op-2010-04-01-1-routes
|
|
description: Handle 80 OpenAPI operation(s) under /2010-04-01 for the 2010 04 01 1 route group.
|
|
---
|
|
|
|
# 2010 04 01 1 API Routes
|
|
|
|
Handle 80 OpenAPI operation(s) under /2010-04-01 for the 2010 04 01 1 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
|
|
|
|
### create_account
|
|
|
|
- Operation ID: `create_account`
|
|
- Route: `POST /2010-04-01/Accounts.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a new Twilio Subaccount from the account making the request
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_account
|
|
|
|
- Operation ID: `list_account`
|
|
- Route: `GET /2010-04-01/Accounts.json`
|
|
- Mode: READ
|
|
- Summary: Retrieves a collection of Accounts belonging to the account used to make the request
|
|
- Parameters:
|
|
- `FriendlyName` in `query`
|
|
- `Status` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### fetch_account
|
|
|
|
- Operation ID: `fetch_account`
|
|
- Route: `GET /2010-04-01/Accounts/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch the account specified by the provided Account Sid
|
|
- Parameters:
|
|
- `Sid` in `path` required
|
|
|
|
### update_account
|
|
|
|
- Operation ID: `update_account`
|
|
- Route: `POST /2010-04-01/Accounts/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Modify the properties of a given Account
|
|
- Parameters:
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### create_address
|
|
|
|
- Operation ID: `create_address`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Addresses.json`
|
|
- Mode: WRITE
|
|
- Summary: CreateAddress
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_address
|
|
|
|
- Operation ID: `list_address`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Addresses.json`
|
|
- Mode: READ
|
|
- Summary: ListAddress
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CustomerName` in `query`
|
|
- `FriendlyName` in `query`
|
|
- `EmergencyEnabled` in `query`
|
|
- `IsoCountry` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### delete_address
|
|
|
|
- Operation ID: `delete_address`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/Addresses/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: DeleteAddress
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### fetch_address
|
|
|
|
- Operation ID: `fetch_address`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Addresses/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: FetchAddress
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### update_address
|
|
|
|
- Operation ID: `update_address`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Addresses/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: UpdateAddress
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### create_application
|
|
|
|
- Operation ID: `create_application`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Applications.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a new application within your account
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_application
|
|
|
|
- Operation ID: `list_application`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Applications.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of applications representing an application within the requesting account
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `FriendlyName` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### delete_application
|
|
|
|
- Operation ID: `delete_application`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete the application by the specified application sid
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### fetch_application
|
|
|
|
- Operation ID: `fetch_application`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch the application specified by the provided sid
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### update_application
|
|
|
|
- Operation ID: `update_application`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Updates the application's properties
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### fetch_authorized_connect_app
|
|
|
|
- Operation ID: `fetch_authorized_connect_app`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps/{ConnectAppSid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an instance of an authorized-connect-app
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ConnectAppSid` in `path` required
|
|
|
|
### list_authorized_connect_app
|
|
|
|
- Operation ID: `list_authorized_connect_app`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of authorized-connect-apps belonging to the account used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_available_phone_number_country
|
|
|
|
- Operation ID: `list_available_phone_number_country`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers.json`
|
|
- Mode: READ
|
|
- Summary: ListAvailablePhoneNumberCountry
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### fetch_available_phone_number_country
|
|
|
|
- Operation ID: `fetch_available_phone_number_country`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json`
|
|
- Mode: READ
|
|
- Summary: FetchAvailablePhoneNumberCountry
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CountryCode` in `path` required
|
|
|
|
### list_available_phone_number_local
|
|
|
|
- Operation ID: `list_available_phone_number_local`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json`
|
|
- Mode: READ
|
|
- Summary: ListAvailablePhoneNumberLocal
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CountryCode` in `path` required
|
|
- `AreaCode` in `query`
|
|
- `Contains` in `query`
|
|
- `SmsEnabled` in `query`
|
|
- `MmsEnabled` in `query`
|
|
- `VoiceEnabled` in `query`
|
|
- `ExcludeAllAddressRequired` in `query`
|
|
- `ExcludeLocalAddressRequired` in `query`
|
|
- `ExcludeForeignAddressRequired` in `query`
|
|
- `Beta` in `query`
|
|
- `NearNumber` in `query`
|
|
- `NearLatLong` in `query`
|
|
- `Distance` in `query`
|
|
- `InPostalCode` in `query`
|
|
- `InRegion` in `query`
|
|
- `InRateCenter` in `query`
|
|
- `InLata` in `query`
|
|
- `InLocality` in `query`
|
|
- `FaxEnabled` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_available_phone_number_machine_to_machine
|
|
|
|
- Operation ID: `list_available_phone_number_machine_to_machine`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/MachineToMachine.json`
|
|
- Mode: READ
|
|
- Summary: ListAvailablePhoneNumberMachineToMachine
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CountryCode` in `path` required
|
|
- `AreaCode` in `query`
|
|
- `Contains` in `query`
|
|
- `SmsEnabled` in `query`
|
|
- `MmsEnabled` in `query`
|
|
- `VoiceEnabled` in `query`
|
|
- `ExcludeAllAddressRequired` in `query`
|
|
- `ExcludeLocalAddressRequired` in `query`
|
|
- `ExcludeForeignAddressRequired` in `query`
|
|
- `Beta` in `query`
|
|
- `NearNumber` in `query`
|
|
- `NearLatLong` in `query`
|
|
- `Distance` in `query`
|
|
- `InPostalCode` in `query`
|
|
- `InRegion` in `query`
|
|
- `InRateCenter` in `query`
|
|
- `InLata` in `query`
|
|
- `InLocality` in `query`
|
|
- `FaxEnabled` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_available_phone_number_mobile
|
|
|
|
- Operation ID: `list_available_phone_number_mobile`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Mobile.json`
|
|
- Mode: READ
|
|
- Summary: ListAvailablePhoneNumberMobile
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CountryCode` in `path` required
|
|
- `AreaCode` in `query`
|
|
- `Contains` in `query`
|
|
- `SmsEnabled` in `query`
|
|
- `MmsEnabled` in `query`
|
|
- `VoiceEnabled` in `query`
|
|
- `ExcludeAllAddressRequired` in `query`
|
|
- `ExcludeLocalAddressRequired` in `query`
|
|
- `ExcludeForeignAddressRequired` in `query`
|
|
- `Beta` in `query`
|
|
- `NearNumber` in `query`
|
|
- `NearLatLong` in `query`
|
|
- `Distance` in `query`
|
|
- `InPostalCode` in `query`
|
|
- `InRegion` in `query`
|
|
- `InRateCenter` in `query`
|
|
- `InLata` in `query`
|
|
- `InLocality` in `query`
|
|
- `FaxEnabled` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_available_phone_number_national
|
|
|
|
- Operation ID: `list_available_phone_number_national`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/National.json`
|
|
- Mode: READ
|
|
- Summary: ListAvailablePhoneNumberNational
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CountryCode` in `path` required
|
|
- `AreaCode` in `query`
|
|
- `Contains` in `query`
|
|
- `SmsEnabled` in `query`
|
|
- `MmsEnabled` in `query`
|
|
- `VoiceEnabled` in `query`
|
|
- `ExcludeAllAddressRequired` in `query`
|
|
- `ExcludeLocalAddressRequired` in `query`
|
|
- `ExcludeForeignAddressRequired` in `query`
|
|
- `Beta` in `query`
|
|
- `NearNumber` in `query`
|
|
- `NearLatLong` in `query`
|
|
- `Distance` in `query`
|
|
- `InPostalCode` in `query`
|
|
- `InRegion` in `query`
|
|
- `InRateCenter` in `query`
|
|
- `InLata` in `query`
|
|
- `InLocality` in `query`
|
|
- `FaxEnabled` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_available_phone_number_shared_cost
|
|
|
|
- Operation ID: `list_available_phone_number_shared_cost`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/SharedCost.json`
|
|
- Mode: READ
|
|
- Summary: ListAvailablePhoneNumberSharedCost
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CountryCode` in `path` required
|
|
- `AreaCode` in `query`
|
|
- `Contains` in `query`
|
|
- `SmsEnabled` in `query`
|
|
- `MmsEnabled` in `query`
|
|
- `VoiceEnabled` in `query`
|
|
- `ExcludeAllAddressRequired` in `query`
|
|
- `ExcludeLocalAddressRequired` in `query`
|
|
- `ExcludeForeignAddressRequired` in `query`
|
|
- `Beta` in `query`
|
|
- `NearNumber` in `query`
|
|
- `NearLatLong` in `query`
|
|
- `Distance` in `query`
|
|
- `InPostalCode` in `query`
|
|
- `InRegion` in `query`
|
|
- `InRateCenter` in `query`
|
|
- `InLata` in `query`
|
|
- `InLocality` in `query`
|
|
- `FaxEnabled` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_available_phone_number_toll_free
|
|
|
|
- Operation ID: `list_available_phone_number_toll_free`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/TollFree.json`
|
|
- Mode: READ
|
|
- Summary: ListAvailablePhoneNumberTollFree
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CountryCode` in `path` required
|
|
- `AreaCode` in `query`
|
|
- `Contains` in `query`
|
|
- `SmsEnabled` in `query`
|
|
- `MmsEnabled` in `query`
|
|
- `VoiceEnabled` in `query`
|
|
- `ExcludeAllAddressRequired` in `query`
|
|
- `ExcludeLocalAddressRequired` in `query`
|
|
- `ExcludeForeignAddressRequired` in `query`
|
|
- `Beta` in `query`
|
|
- `NearNumber` in `query`
|
|
- `NearLatLong` in `query`
|
|
- `Distance` in `query`
|
|
- `InPostalCode` in `query`
|
|
- `InRegion` in `query`
|
|
- `InRateCenter` in `query`
|
|
- `InLata` in `query`
|
|
- `InLocality` in `query`
|
|
- `FaxEnabled` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_available_phone_number_voip
|
|
|
|
- Operation ID: `list_available_phone_number_voip`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Voip.json`
|
|
- Mode: READ
|
|
- Summary: ListAvailablePhoneNumberVoip
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CountryCode` in `path` required
|
|
- `AreaCode` in `query`
|
|
- `Contains` in `query`
|
|
- `SmsEnabled` in `query`
|
|
- `MmsEnabled` in `query`
|
|
- `VoiceEnabled` in `query`
|
|
- `ExcludeAllAddressRequired` in `query`
|
|
- `ExcludeLocalAddressRequired` in `query`
|
|
- `ExcludeForeignAddressRequired` in `query`
|
|
- `Beta` in `query`
|
|
- `NearNumber` in `query`
|
|
- `NearLatLong` in `query`
|
|
- `Distance` in `query`
|
|
- `InPostalCode` in `query`
|
|
- `InRegion` in `query`
|
|
- `InRateCenter` in `query`
|
|
- `InLata` in `query`
|
|
- `InLocality` in `query`
|
|
- `FaxEnabled` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### fetch_balance
|
|
|
|
- Operation ID: `fetch_balance`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Balance.json`
|
|
- Mode: READ
|
|
- Summary: Fetch the balance for an Account based on Account Sid. Balance changes may not be reflected immediately. Child accounts do not contain balance information
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
|
|
### create_call
|
|
|
|
- Operation ID: `create_call`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Calls.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a new outgoing call to phones, SIP-enabled endpoints or Twilio Client connections
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_call
|
|
|
|
- Operation ID: `list_call`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Calls.json`
|
|
- Mode: READ
|
|
- Summary: Retrieves a collection of calls made to and from your account
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `To` in `query`
|
|
- `From` in `query`
|
|
- `ParentCallSid` in `query`
|
|
- `Status` in `query`
|
|
- `StartTime` in `query`
|
|
- `StartTime<` in `query`
|
|
- `StartTime>` in `query`
|
|
- `EndTime` in `query`
|
|
- `EndTime<` in `query`
|
|
- `EndTime>` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### delete_call
|
|
|
|
- Operation ID: `delete_call`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/Calls/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: 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:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### fetch_call
|
|
|
|
- Operation ID: `fetch_call`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Calls/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch the call specified by the provided Call SID
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### update_call
|
|
|
|
- Operation ID: `update_call`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Calls/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Initiates a call redirect or terminates a call
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_call_event
|
|
|
|
- Operation ID: `list_call_event`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Events.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of all events for a call.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### fetch_call_notification
|
|
|
|
- Operation ID: `fetch_call_notification`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: FetchCallNotification
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_call_notification
|
|
|
|
- Operation ID: `list_call_notification`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications.json`
|
|
- Mode: READ
|
|
- Summary: ListCallNotification
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- `Log` in `query`
|
|
- `MessageDate` in `query`
|
|
- `MessageDate<` in `query`
|
|
- `MessageDate>` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### create_call_recording
|
|
|
|
- Operation ID: `create_call_recording`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json`
|
|
- Mode: WRITE
|
|
- Summary: Create a recording for the call
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_call_recording
|
|
|
|
- Operation ID: `list_call_recording`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of recordings belonging to the call used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- `DateCreated` in `query`
|
|
- `DateCreated<` in `query`
|
|
- `DateCreated>` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### update_call_recording
|
|
|
|
- Operation ID: `update_call_recording`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: 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:
|
|
- `AccountSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### fetch_call_recording
|
|
|
|
- Operation ID: `fetch_call_recording`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an instance of a recording for a call
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### delete_call_recording
|
|
|
|
- Operation ID: `delete_call_recording`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete a recording from your account
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### fetch_conference
|
|
|
|
- Operation ID: `fetch_conference`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an instance of a conference
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### update_conference
|
|
|
|
- Operation ID: `update_conference`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: UpdateConference
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_conference
|
|
|
|
- Operation ID: `list_conference`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Conferences.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of conferences belonging to the account used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `DateCreated` in `query`
|
|
- `DateCreated<` in `query`
|
|
- `DateCreated>` in `query`
|
|
- `DateUpdated` in `query`
|
|
- `DateUpdated<` in `query`
|
|
- `DateUpdated>` in `query`
|
|
- `FriendlyName` in `query`
|
|
- `Status` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_conference_recording
|
|
|
|
- Operation ID: `list_conference_recording`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of recordings belonging to the call used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ConferenceSid` in `path` required
|
|
- `DateCreated` in `query`
|
|
- `DateCreated<` in `query`
|
|
- `DateCreated>` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### update_conference_recording
|
|
|
|
- Operation ID: `update_conference_recording`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Changes the status of the recording to paused, stopped, or in-progress. Note: To use `Twilio.CURRENT`, pass it as recording sid.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ConferenceSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### fetch_conference_recording
|
|
|
|
- Operation ID: `fetch_conference_recording`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an instance of a recording for a call
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ConferenceSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### delete_conference_recording
|
|
|
|
- Operation ID: `delete_conference_recording`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete a recording from your account
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ConferenceSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### fetch_connect_app
|
|
|
|
- Operation ID: `fetch_connect_app`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an instance of a connect-app
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### update_connect_app
|
|
|
|
- Operation ID: `update_connect_app`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Update a connect-app with the specified parameters
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_connect_app
|
|
|
|
- Operation ID: `delete_connect_app`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete an instance of a connect-app
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_connect_app
|
|
|
|
- Operation ID: `list_connect_app`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/ConnectApps.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of connect-apps belonging to the account used to make the request
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_dependent_phone_number
|
|
|
|
- Operation ID: `list_dependent_phone_number`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Addresses/{AddressSid}/DependentPhoneNumbers.json`
|
|
- Mode: READ
|
|
- Summary: ListDependentPhoneNumber
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `AddressSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### update_incoming_phone_number
|
|
|
|
- Operation ID: `update_incoming_phone_number`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Update an incoming-phone-number instance.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### fetch_incoming_phone_number
|
|
|
|
- Operation ID: `fetch_incoming_phone_number`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an incoming-phone-number belonging to the account used to make the request.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### delete_incoming_phone_number
|
|
|
|
- Operation ID: `delete_incoming_phone_number`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete a phone-numbers belonging to the account used to make the request.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_incoming_phone_number
|
|
|
|
- Operation ID: `list_incoming_phone_number`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of incoming-phone-numbers belonging to the account used to make the request.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Beta` in `query`
|
|
- `FriendlyName` in `query`
|
|
- `PhoneNumber` in `query`
|
|
- `Origin` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### create_incoming_phone_number
|
|
|
|
- Operation ID: `create_incoming_phone_number`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json`
|
|
- Mode: WRITE
|
|
- Summary: Purchase a phone-number for the account.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### fetch_incoming_phone_number_assigned_add_on
|
|
|
|
- Operation ID: `fetch_incoming_phone_number_assigned_add_on`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an instance of an Add-on installation currently assigned to this Number.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ResourceSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### delete_incoming_phone_number_assigned_add_on
|
|
|
|
- Operation ID: `delete_incoming_phone_number_assigned_add_on`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Remove the assignment of an Add-on installation from the Number specified.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ResourceSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_incoming_phone_number_assigned_add_on
|
|
|
|
- Operation ID: `list_incoming_phone_number_assigned_add_on`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of Add-on installations currently assigned to this Number.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ResourceSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### create_incoming_phone_number_assigned_add_on
|
|
|
|
- Operation ID: `create_incoming_phone_number_assigned_add_on`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns.json`
|
|
- Mode: WRITE
|
|
- Summary: Assign an Add-on installation to the Number specified.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ResourceSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### fetch_incoming_phone_number_assigned_add_on_extension
|
|
|
|
- Operation ID: `fetch_incoming_phone_number_assigned_add_on_extension`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch an instance of an Extension for the Assigned Add-on.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ResourceSid` in `path` required
|
|
- `AssignedAddOnSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_incoming_phone_number_assigned_add_on_extension
|
|
|
|
- Operation ID: `list_incoming_phone_number_assigned_add_on_extension`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of Extensions for the Assigned Add-on.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `ResourceSid` in `path` required
|
|
- `AssignedAddOnSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### list_incoming_phone_number_local
|
|
|
|
- Operation ID: `list_incoming_phone_number_local`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Local.json`
|
|
- Mode: READ
|
|
- Summary: ListIncomingPhoneNumberLocal
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Beta` in `query`
|
|
- `FriendlyName` in `query`
|
|
- `PhoneNumber` in `query`
|
|
- `Origin` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### create_incoming_phone_number_local
|
|
|
|
- Operation ID: `create_incoming_phone_number_local`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Local.json`
|
|
- Mode: WRITE
|
|
- Summary: CreateIncomingPhoneNumberLocal
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_incoming_phone_number_mobile
|
|
|
|
- Operation ID: `list_incoming_phone_number_mobile`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Mobile.json`
|
|
- Mode: READ
|
|
- Summary: ListIncomingPhoneNumberMobile
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Beta` in `query`
|
|
- `FriendlyName` in `query`
|
|
- `PhoneNumber` in `query`
|
|
- `Origin` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### create_incoming_phone_number_mobile
|
|
|
|
- Operation ID: `create_incoming_phone_number_mobile`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Mobile.json`
|
|
- Mode: WRITE
|
|
- Summary: CreateIncomingPhoneNumberMobile
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_incoming_phone_number_toll_free
|
|
|
|
- Operation ID: `list_incoming_phone_number_toll_free`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/TollFree.json`
|
|
- Mode: READ
|
|
- Summary: ListIncomingPhoneNumberTollFree
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Beta` in `query`
|
|
- `FriendlyName` in `query`
|
|
- `PhoneNumber` in `query`
|
|
- `Origin` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### create_incoming_phone_number_toll_free
|
|
|
|
- Operation ID: `create_incoming_phone_number_toll_free`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/TollFree.json`
|
|
- Mode: WRITE
|
|
- Summary: CreateIncomingPhoneNumberTollFree
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### fetch_key
|
|
|
|
- Operation ID: `fetch_key`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: FetchKey
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### update_key
|
|
|
|
- Operation ID: `update_key`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: UpdateKey
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_key
|
|
|
|
- Operation ID: `delete_key`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: DeleteKey
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_key
|
|
|
|
- Operation ID: `list_key`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Keys.json`
|
|
- Mode: READ
|
|
- Summary: ListKey
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### create_new_key
|
|
|
|
- Operation ID: `create_new_key`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Keys.json`
|
|
- Mode: WRITE
|
|
- Summary: CreateNewKey
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_media
|
|
|
|
- Operation ID: `delete_media`
|
|
- Route: `DELETE /2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media/{Sid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Delete the Media resource.
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `MessageSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### fetch_media
|
|
|
|
- Operation ID: `fetch_media`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media/{Sid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch a single Media resource associated with a specific Message resource
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `MessageSid` in `path` required
|
|
- `Sid` in `path` required
|
|
|
|
### list_media
|
|
|
|
- Operation ID: `list_media`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media.json`
|
|
- Mode: READ
|
|
- Summary: Read a list of Media resources associated with a specific Message resource
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `MessageSid` in `path` required
|
|
- `DateCreated` in `query`
|
|
- `DateCreated<` in `query`
|
|
- `DateCreated>` in `query`
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### fetch_member
|
|
|
|
- Operation ID: `fetch_member`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}.json`
|
|
- Mode: READ
|
|
- Summary: Fetch a specific member from the queue
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `QueueSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
|
|
### update_member
|
|
|
|
- Operation ID: `update_member`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}.json`
|
|
- Mode: WRITE
|
|
- Summary: Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `QueueSid` in `path` required
|
|
- `CallSid` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_member
|
|
|
|
- Operation ID: `list_member`
|
|
- Route: `GET /2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members.json`
|
|
- Mode: READ
|
|
- Summary: Retrieve the members of the queue
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- `QueueSid` in `path` required
|
|
- `PageSize` in `query`
|
|
- `Page` in `query`
|
|
- `PageToken` in `query`
|
|
|
|
### create_message
|
|
|
|
- Operation ID: `create_message`
|
|
- Route: `POST /2010-04-01/Accounts/{AccountSid}/Messages.json`
|
|
- Mode: WRITE
|
|
- Summary: Send a message
|
|
- Parameters:
|
|
- `AccountSid` in `path` required
|
|
- Body: JSON request body accepted.
|