API 3 Changelog

The changelog is a list of backwards-incompatible updates in the API.

2021-12-15

  • BREAKING CHANGE /v3/trunks being moved to /v3/voice_in_trunks.

  • BREAKING CHANGE /v3/trunk_groups being moved to /v3/voice_in_trunk_groups.

  • BREAKING CHANGE /v3/cdr_exports being moved to /v3/exports.

    Endpoint now allows generating both inbound and outbound CDRs export.

  • BREAKING CHANGE /v3/exports result file will be CSV archived in GZIP.

  • BREAKING CHANGE Callbacks payload for exports being changed:

    value of type attribute is changed to exports.

  • BREAKING CHANGE /v3/exports export_type required attribute being added

    to request and response with possible values: cdr_in, cdr_out.

  • BREAKING CHANGE /v3/exports filters attribute being removed from response.

  • BREAKING CHANGE /v3/did_groups filter features allowed values to be changed to

    sms_in, sms_out, voice_in, voice_out, t38.

  • BREAKING CHANGE /v3/did_groups response value of features attribute to be changed to

    sms_in, sms_out, voice_in, voice_out, t38.

  • BREAKING CHANGE /v3/available_dids filter did_group.features allowed values being changed to

    sms_in, sms_out, voice_in, voice_out, t38.

  • BREAKING CHANGE /v3/dids rename trunk_group relationship to voice_in_trunk_group

    with type voice_in_trunk_groups.

  • BREAKING CHANGE /v3/dids rename trunks relationship to voice_in_trunks

    with type voice_in_trunks.

  • /v3/voice_out_trunks endpoints being added.

  • /v3/voice_out_trunk_regenerate_credentials endpoint being added.

  • /v3/voice_in_trunks SIP configuration

    additional attributes being added to request and response: media_encryption_mode, stir_shaken_mode, allowed_rtp_ips.

  • /v3/dids filter add filter did_group.features with allowed values:

    sms_in, sms_out, voice_in, voice_out, t38.

  • Callbacks allow receiving events about /v3/voice_out_trunks status change.

2021-04-19

  • BREAKING CHANGE /v3/dids in request and response attributes pending_removal being removed in favor of billing_cycles_count.

    This attribute allows you to control how many billing cycles DID will leave before being terminated. null value means that DID will be renewed infinitely. 0 value means that DID will not be renewed. 2 value means that DID will be renewed only twice. After each renew value will be decreased by 1 if it is set. Value can be set from 0 to 999.

  • ENHANCEMENT /v3/orders request attribute items of type DID Order Item Attributes can have billing_cycles_count.

    As result DIDs will be created with billing_cycles_count being set to passed value. Same rules apply for this value as for /v3/dids request attribute. By default value will be null.

  • BREAKING CHANGE /v3/did_groups restriction message removed in favor of requirements relationship.

  • ENHANCEMENT /v3/dids added address_verification relationship.

  • ENHANCEMENT callbacks attributes added to /v3/order , /v3/cdr_export.

  • /v3/proof_types read endpoints being added.

  • /v3/supporting_document_templates read endpoints being added.

  • /v3/requirements read endpoints being added.

  • /v3/identities read, write, and delete endpoints being added.

  • /v3/addresses read, write, and delete endpoints being added.

  • /v3/encrypted_files read, write, and delete endpoints being added.

  • /v3/proofs write, delete endpoint being added.

  • /v3/permanent_supporting_documents write, delete endpoint being added.

  • /v3/address_verifications read and write endpoints being added.

  • /v3/requirement_validations write endpoint being added.

Full list of resources available here.

See Callback details.