Get Codec Options

Retrieve the available codec options for a tenant.

Request URL

GET {base_url}/uc-cconfig/api/v1/sip-setting/codec-options

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Codec_Options> The available codec options for the tenant.
Codec_Options
Parameter Type Description
audioCodecs Array<String> The available audio codecs.

Example

Request example

GET /uc-cconfig/api/v1/sip-setting/codec-options HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDY2NjQ5MSwiaWF0IjoxNzkwNjQ0ODkxLCJqdGkiOiI3NDM2MWEwZC1kNzJmLTRlZjctYjQ2Zi1mODEwYjRmNWQ0NWIiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.zyCrspAIuTTEggTUAc3cLDqZYlWrbPKq4sNau5m2YW3mGqemuufeRMzvneF-aDpLKxN8BzXL5zxeR0XPySoLqmz5WSBAjxWyev3mCLew8cMKArusR9rTRyMKRl-h_DfYj0fAWjOr498KZPKUYMLr0iXnJYzg45Lqwz2zntMLSCpDQhbHnrGDXIVGasY1pOI0cmm8PEpCYD0GsyOxccpyKFZ0pFMfmjYP2e9fnB3deEGPg01tfDTnMYP0AgfoyzMb-D1ULzhuS3YFjvkjpQoaQy0nLLTlW0aQXSG5gIkDTDrcAx07jsgNOOVxFllp2XgGoGPnhgvvvpzIWK82M1norQ

Response example

HTTP/1.1 200 OK
{
  "requestId": "abcfe128707dfe40fe127036b62bc5b4",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "audioCodecs": [
      "PCMU",
      "PCMA",
      "G722",
      "G729",
      "OPUS"
    ]
  }
}