API Versioning

The DIDWW API v3 uses versioning to ensure backward compatibility while enabling new features and enhancements. Versioning is based on the date of your first request using API v3.

  • Each customer is assigned a fixed API version when they first use the API.

  • The version will not change automatically. You are responsible for upgrading via the DIDWW User Panel when ready.

  • New versions may introduce changes to existing behavior or add new parameters and resources.

You can view your current API version in the response metadata field: meta.api_version.

To review or change your current version, visit the API page in the User Panel .


Upgrading Your API Version

You may test or adopt a newer API version by including the X-DIDWW-API-Version header in your requests. This header overrides the default version for the current request only.

http

GET /v3/voice_in_trunk_groups HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Api-Key: [API Token]
X-DIDWW-API-Version: 2022-05-10

curl

curl -i -X GET https://api.didww.com/v3/voice_in_trunk_groups -H "Api-Key: [API Token]" -H "Content-Type: application/vnd.api+json" -H "X-Didww-Api-Version: 2022-05-10"

response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "id": "12345678-abcd-4321-efgh-9876543210ab",
      "type": "voice_in_trunk_groups",
      "attributes": {
        "created_at": "2023-09-01T08:06:37.162Z",
        "name": "TG test",
        "capacity_limit": null
      },
      "relationships": {
        "voice_in_trunks": {}
      },
      "meta": {
        "trunks_count": 2
      }
    }
  ],
  "meta": {
    "total_records": 1,
    "api_version": "2022-05-10"
  }
}

You can manage your default API version in the DIDWW User Panel .

Important

  • If the X-DIDWW-API-Version header specifies a version older than your currently assigned version, it will be ignored.

  • Downgrading your API version is not supported.

  • The meta.api_version field in the response reflects the version used for that request.