Carriers
A carrier is a wholesale provider whose call data and charges feed into billing. See the Carriers guide for how carriers are used.
Methods
Section titled “Methods”Retrieve Single Carrier
Section titled “Retrieve Single Carrier”/backend/api/v1/carriers/ID - fetch the carrier with the specified ID.
List Carriers
Section titled “List Carriers”/backend/api/v1/carriers/ - list all carriers.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include carriers with a higher ID |
createdSince | datetime | No | Only include carriers created since the given time |
updatedSince | datetime | No | Only include carriers updated since the given time |
/backend/api/v1/carriers/ - add a new carrier. The newly-added carrier will be returned.
/backend/api/v1/carriers/ID - update the carrier with the specified ID. The modified carrier will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/carriers/ID - delete the carrier with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| name | Name | Text | Name of the telecommunications carrier |
| requiredForRun | Required For Run | Preset Value(s) | Array of billing run names that require this carrier |
| CDRsInArrearsMonths | CDRs in Arrears (Months) | Number | Number of months that CDRs from this carrier typically arrive in arrears |
| callCarrier | Call Carrier | Preset Value | Whether this carrier is used for call services |
| lineCarrier | Line Carrier | Preset Value | Whether this carrier is used for line services |
| featureCarrier | Feature Carrier | Preset Value | Whether this carrier is used for feature carrier selection |
| serviceCarrier | Service Carrier | Preset Value | Whether this carrier is used for service provider selection |
| provisioningAPI | Use Provisioning API | Preset Value |