API overviewΒΆ

CUSTOMERS

  • GET /customers - returns a list of customers

  • POST /customers - creates a customer

  • GET /customers/{id} - returns a single customer

  • PATCH /customers/{id} - updates a customer

CUSTOMER SESSIONS

  • POST /sessions - creates a session for customer to access the UI

ADMIN SESSIONS

  • POST /customer_admin_sessions - creates a session for admin to access the customer UI

INCOMING TRUNKS

  • GET /incoming_trunks - returns a list of incoming trunks

  • POST /incoming_trunks - creates an incoming trunk

  • DELETE /incoming_trunks/{id} - deletes an incoming trunk

  • GET /incoming_trunks/{id} - returns a single incoming trunk

  • PATCH /incoming_trunks/{id} - updates an incoming trunk

DID NUMBERS

  • GET /available_did_numbers - returns a list of available DID numbers

  • POST /available_did_numbers - creates an available DID number

  • DELETE /available_did_numbers/{id} - deletes an available DID number

  • GET /available_did_numbers/{id} - returns an available DID number

  • PATCH /available_did_numbers/{id} - updates an available DID number

GATEWAYS

  • DELETE /termination_gateways/{id} - deletes a termination gateway

  • GET /termination_gateways/{id} - returns a single termination gateway

  • PATCH /termination_gateways/{id} - updates a termination gateway

  • GET /termination_gateways - returns a list of termination gateways

  • POST /termination_gateways - creates a termination gateway

EXTERNAL ACCOUNTS

  • GET /external_account_routes - returns a list of external account routes (SIM Cards)

  • POST /external_account_routes - creates an external account route (SIM Card)

  • GET /external_account_routes/{id} - returns a single external account route (SIM Card)

  • PATCH /external_account_routes/{id} - updates an external account route (SIM Card)

SIP ACCOUNTS

  • GET /sip_device_routes - returns list of SIP device routes

  • GET /sip_device_routes/{id} - return single SIP device route

  • PATCH /sip_device_routes/{id} - update SIP device route

TERMINATION CDRs

  • GET /termination_cdrs - returns a list of termination CDRs

  • GET /termination_cdrs/{id} - returns a single termination CDR

INCOMING TRUNK CDRS

  • GET /incoming_trunk_cdrs - returns a list of incoming trunk CDRs

  • GET /incoming_trunk_cdrs/{id} - returns a single incoming trunk CDR