# Create a Recording POST https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings Content-Type: application/x-www-form-urlencoded Create a recording. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space). Reference: https://signalwire.com/docs/compatibility-api/rest/recordings/create-recording ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: compatibility version: 1.0.0 paths: /Accounts/{AccountSid}/Calls/{CallSid}/Recordings: post: operationId: create-recording summary: Create a Recording description: >- Create a recording. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space). tags: - subpackage_recordings parameters: - name: AccountSid in: path description: The Project ID that uniquely identifies the Account. required: true schema: type: string format: uuid - name: CallSid in: path description: The unique identifier for the call. required: true schema: type: string format: uuid - name: Authorization in: header description: >- SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ``` required: true schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CallRecordingResponse' '400': description: >- The request was invalid or cannot be processed. Check the error details for more information. content: application/json: schema: $ref: '#/components/schemas/CompatibilityErrorResponse' '401': description: Authentication failed. Please verify your credentials and try again. content: application/json: schema: $ref: '#/components/schemas/CompatibilityErrorResponse' '404': description: >- The requested resource was not found. Please verify the resource identifier. content: application/json: schema: $ref: '#/components/schemas/CompatibilityErrorResponse' '422': description: >- The request could not be processed due to validation errors. Check the error details for more information. content: application/json: schema: $ref: '#/components/schemas/CompatibilityErrorResponse' '503': description: The service is temporarily unavailable. Please try again later. content: application/json: schema: $ref: '#/components/schemas/CompatibilityErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCallRecordingRequest' servers: - url: https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01 components: schemas: CreateCallRecordingRequestRecordingChannels: type: string enum: - mono - dual default: mono description: >- The number of channels in the recording. Can be `mono` (both legs of call recorded under one channel into one recording file) or `dual` (each leg of call recorded in separate channels into one recording file). Default is `mono`. title: CreateCallRecordingRequestRecordingChannels CreateCallRecordingRequestRecordingStatusCallbackMethod: type: string enum: - GET - POST default: POST description: >- Whether the request to `RecordingStatusCallback` URL is a `GET` or a `POST`. Default is `POST`. title: CreateCallRecordingRequestRecordingStatusCallbackMethod CreateCallRecordingRequestRecordingTrack: type: string enum: - inbound - outbound - both default: both description: >- Specifies whether to record the `inbound` audio to SignalWire from the called party or the `outbound` audio from SignalWire to the called party or `both` the inbound and outbound audio. Default is `both`. title: CreateCallRecordingRequestRecordingTrack CreateCallRecordingRequestTrim: type: string enum: - trim-silence - do-not-trim default: do-not-trim description: >- Whether leading and trailing silence is trimmed from a recording. Default is `do-not-trim`. title: CreateCallRecordingRequestTrim CreateCallRecordingRequest: type: object properties: RecordingChannels: $ref: '#/components/schemas/CreateCallRecordingRequestRecordingChannels' description: >- The number of channels in the recording. Can be `mono` (both legs of call recorded under one channel into one recording file) or `dual` (each leg of call recorded in separate channels into one recording file). Default is `mono`. RecordingStatusCallback: type: string format: uri description: >- The URL to request to when recording is available. See the [Recording status callback](/docs/compatibility-api/rest/recordings/webhooks/recording-status-callback) webhook for the payload your URL will receive. RecordingStatusCallbackEvent: type: string default: completed description: >- The different recording statuses. To specify multiple events, separate with a space. Valid values: completed, in-progress, absent. Default is `completed`. RecordingStatusCallbackMethod: $ref: >- #/components/schemas/CreateCallRecordingRequestRecordingStatusCallbackMethod description: >- Whether the request to `RecordingStatusCallback` URL is a `GET` or a `POST`. Default is `POST`. RecordingTrack: $ref: '#/components/schemas/CreateCallRecordingRequestRecordingTrack' description: >- Specifies whether to record the `inbound` audio to SignalWire from the called party or the `outbound` audio from SignalWire to the called party or `both` the inbound and outbound audio. Default is `both`. Trim: $ref: '#/components/schemas/CreateCallRecordingRequestTrim' description: >- Whether leading and trailing silence is trimmed from a recording. Default is `do-not-trim`. description: Request body for creating a call recording. title: CreateCallRecordingRequest CallRecordingResponseChannel: type: string enum: - '1' - '2' description: >- The number of channels in a recording (singular key). Returns '1' for mono or '2' for stereo. title: CallRecordingResponseChannel CallRecordingResponseChannels: type: string enum: - '1' - '2' description: >- The number of channels in a recording. Returns '1' for mono or '2' for stereo. title: CallRecordingResponseChannels RecordingSource: type: string enum: - DialVerb - Conference - OutBoundApi - Trunking - RecordVerb - StartCallRecordingApi - StartConferenceRecording description: Recording source. title: RecordingSource RecordingStatus: type: string enum: - queued - in-progress - paused - resumed - completed - absent - stopped description: Recording status. title: RecordingStatus RecordingSubresourceUris: type: object properties: transcriptions: type: string description: The URI for transcriptions. required: - transcriptions description: Recording subresource URIs. title: RecordingSubresourceUris CallRecordingResponse: type: object properties: sid: type: string format: uuid description: The unique identifier for the recording. account_sid: type: string format: uuid description: >- The unique identifier for the account that is associated with this recording. api_version: type: string description: The version of the SignalWire API. call_sid: type: - string - 'null' format: uuid description: >- The unique identifier for the call that is associated with this recording. Null if this is a conference recording. conference_sid: type: - string - 'null' format: uuid description: >- The unique identifier for the conference that is associated with this recording. Null if this is a call recording. channel: $ref: '#/components/schemas/CallRecordingResponseChannel' description: >- The number of channels in a recording (singular key). Returns '1' for mono or '2' for stereo. channels: $ref: '#/components/schemas/CallRecordingResponseChannels' description: >- The number of channels in a recording. Returns '1' for mono or '2' for stereo. date_created: type: string description: The date, in RFC 2822 format, this recording was created. date_updated: type: string description: The date, in RFC 2822 format, this recording was updated. start_time: type: - string - 'null' description: The time, in RFC 2822 format, this recording started. end_time: type: - string - 'null' description: The time, in RFC 2822 format, this recording ended. duration: type: integer description: The length, in seconds, of the recording. price: type: - string - 'null' description: The cost for the recording. price_unit: type: string description: The currency of the price of the recording. source: $ref: '#/components/schemas/RecordingSource' description: How the recording was made. status: $ref: '#/components/schemas/RecordingStatus' description: The status of the recording. error_code: type: - string - 'null' description: Further details about a failed recording. uri: type: string description: The URI of the recording. subresource_uris: $ref: '#/components/schemas/RecordingSubresourceUris' description: Subresource URIs. encryption_details: type: - string - 'null' description: Encryption details. Always null. trim: type: string description: Whether leading and trailing silence is trimmed from a recording. required: - sid - account_sid - api_version - call_sid - conference_sid - channel - channels - date_created - date_updated - start_time - end_time - duration - price - price_unit - source - status - error_code - uri - subresource_uris - encryption_details - trim description: Response containing a single call recording. title: CallRecordingResponse CompatibilityErrorResponse: type: object properties: code: type: integer description: Error code. message: type: string description: Error message. more_info: type: string description: URL for more information about the error. status: type: integer description: HTTP status code. required: - code - message - more_info - status description: Error response model. title: CompatibilityErrorResponse securitySchemes: SignalWireBasicAuth: type: http scheme: basic description: >- SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ``` ``` ## SDK Code Examples ```python import requests url = "https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Calls/CallSid/Recordings" payload = "" headers = { "Authorization": "Basic :", "Content-Type": "application/x-www-form-urlencoded" } response = requests.post(url, data=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Calls/CallSid/Recordings'; const options = { method: 'POST', headers: { Authorization: 'Basic :', 'Content-Type': 'application/x-www-form-urlencoded' }, body: new URLSearchParams('') }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Calls/CallSid/Recordings" req, _ := http.NewRequest("POST", url, nil) req.Header.Add("Authorization", "Basic :") req.Header.Add("Content-Type", "application/x-www-form-urlencoded") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Calls/CallSid/Recordings") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Basic :' request["Content-Type"] = 'application/x-www-form-urlencoded' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Calls/CallSid/Recordings") .header("Authorization", "Basic :") .header("Content-Type", "application/x-www-form-urlencoded") .asString(); ``` ```php request('POST', 'https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Calls/CallSid/Recordings', [ 'form_params' => null, 'headers' => [ 'Authorization' => 'Basic :', 'Content-Type' => 'application/x-www-form-urlencoded', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Calls/CallSid/Recordings"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Basic :"); request.AddHeader("Content-Type", "application/x-www-form-urlencoded"); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Basic :", "Content-Type": "application/x-www-form-urlencoded" ] let request = NSMutableURLRequest(url: NSURL(string: "https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Calls/CallSid/Recordings")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```