Sign in
Carrier

Create

Create a new Carrier record.

post/api/cp/carrier

Request body

idinteger

Id

account_idinteger

Account Id

reseller_idinteger

Reseller Id

namestring required

Name

aliasstring

Alias

channelsinteger

Channels

cpsnumber

Cps

system_idstring

System Id

statusstring

Status

address1string

Address 1

address2string

Address 2

citystring

City

countystring

County

postcodestring

Postcode

websitestring uri

Website

countrystring

Country

credit_refresh_intervalinteger

Credit Refresh Interval

portal_jsonstring

Portal Json

portal_urlstring uri

Portal Url

portal_usernamestring

Portal Username

portal_passwordstring password

Portal Password

email_credit_regexstring

Email Credit Regex

traceinteger

Trace

creditnumber required

Credit

debit_limitnumber required

Debit Limit

taxnumber required

Tax

snapshot_creditnumber

Snapshot Credit

snapshot_timestampinteger

Snapshot Timestamp

currencystring

Currency

paypalstring

Paypal

portal_accessstring

Portal Access

is_customerinteger

Is Customer

is_carrierinteger

Is Carrier

last_callinteger nullable

Last Call

auto_login_keystring

Auto Login Key

connexcs_permissionstring

Connexcs Permission

fr_timeoutinteger

Fr Timeout

pre_ring_timeoutinteger required

Pre Ring Timeout

post_ring_timeoutinteger required

Post Ring Timeout

p_asserted_identity'default' | 'remove' | 'if-available' | 'required' required

P Asserted Identity

reply_actionsobject required

Reply Actions

reply_actions_jsonobject required

Reply Actions Json

did_api_idstring

Did Api Id

account_api_idstring

Account Api Id

resources_usedstring binary

Resources Used

code_consistencynumber

Code Consistency

code_consistency_pointsnumber

Code Consistency Points

min_paymentnumber

Min Payment

approved_cli_onlyinteger required

Approved Cli Only

invoice_schedule'day' | 'week' | 'bimonth' | 'month' | 'disabled' required

Invoice Schedule

invoice_due_daysinteger

Invoice Due Days

propagate_usernameinteger

Propagate Username

requiredstring[] required

Required

duration_latency_offsetnumber

Duration Latency Offset

notesstring

Notes

consec_backoffinteger

Consec Backoff

tagsstring required

Tags

varsstring

Vars

topup_currenciesstring

Topup Currencies

accounting_idstring

Accounting Id

invoice_templatestring

Invoice Template

account_manager_idinteger

Account Manager Id

origidstring

Origid

rtp_firewall_warninginteger

Rtp Firewall Warning

s3_sizenumber

S 3 Size

call_recording_retention_daysinteger

Call Recording Retention Days

range_holder_provider_card_idstring

Range Holder Provider Card Id

domain_idinteger

Domain Id

cx_referalinteger required

Cx Referal

max_daily_spendnumber

Max Daily Spend

dt_restrictobject

Dt Restrict

default_stir_shaken_attestation'A' | 'B' | 'C'

Default Stir Shaken Attestation

flagsstring required

Flags

Example request

{
  "id": 12345,
  "account_id": 1,
  "reseller_id": 1,
  "name": "Example Name",
  "alias": "example_alias",
  "channels": 123,
  "cps": 1.5,
  "system_id": 1,
  "status": "Active",
  "address1": "example_address1",
  "address2": "example_address2",
  "city": "example_city",
  "county": 10,
  "postcode": "example_postcode",
  "website": "https://example.com",
  "country": "US",
  "credit_refresh_interval": 123,
  "portal_json": "Sample portal_json text content",
  "portal_url": "example_portal_url",
  "portal_username": "example_portal_username",
  "portal_password": "example_portal_password",
  "email_credit_regex": "example_email_credit_regex",
  "trace": 1,
  "credit": 99.99,
  "debit_limit": 99.99,
  "tax": 99.99,
  "snapshot_credit": 99.99,
  "snapshot_timestamp": 1000000,
  "currency": "USD",
  "paypal": "example_paypal",
  "portal_access": "example_portal_access",
  "is_customer": true,
  "is_carrier": true,
  "last_call": 1000000,
  "auto_login_key": "example_auto_login_key",
  "connexcs_permission": "example_connexcs_permission",
  "fr_timeout": 1,
  "pre_ring_timeout": 1,
  "post_ring_timeout": 1,
  "p_asserted_identity": "default",
  "reply_actions": "example_reply_actions",
  "reply_actions_json": "example_reply_actions_json",
  "did_api_id": 1,
  "account_api_id": 1,
  "resources_used": "base64-encoded-data",
  "code_consistency": 99.99,
  "code_consistency_points": 99.99,
  "min_payment": 99.99,
  "approved_cli_only": 1,
  "invoice_schedule": "day",
  "invoice_due_days": 1,
  "propagate_username": 1,
  "required": "mobile_verification",
  "duration_latency_offset": 99.99,
  "notes": "Sample notes text content",
  "consec_backoff": 1,
  "tags": "example_tags",
  "vars": "Sample vars text content",
  "topup_currencies": "example_topup_currencies",
  "accounting_id": 1,
  "invoice_template": "example_invoice_template",
  "account_manager_id": 1,
  "origid": "example_origid",
  "rtp_firewall_warning": 1,
  "s3_size": 1.5,
  "call_recording_retention_days": 123,
  "range_holder_provider_card_id": 1,
  "domain_id": 1,
  "cx_referal": 1,
  "max_daily_spend": 99.99,
  "dt_restrict": "example_dt_restrict",
  "default_stir_shaken_attestation": "A",
  "flags": "example_flags"
}

Response

Successful response

statusstring

Operation status

Example response

{
  "id": 12345,
  "status": "OK"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.