Create a new SIP trunk with automatically generated username.

Important Notes

  • Usernames are automatically generated in the format 'CTXXXXXX' (where X is a random digit)
  • Custom usernames are not supported
  • Caller ID numbers must be verified before they can be used
    • You can get a list of your verified numbers using GET /api/v1/account/verified-cli/
    • Additional numbers can be verified through your Crazytel Account portal
    • Any numbers purchased on your account automatically become verified numbers
  • SMS sender numbers must be verified and start with '614'

Parameters

Request body containing:

  • password: Required password for the trunk
    • Must be at least 8 characters long
    • Must contain at least 1 uppercase letter
    • Must contain at least 1 lowercase letter
    • Must contain at least 1 number
  • caller_id_number: Required caller ID number
    • Must be pre-verified for your account
    • Used for outbound calls
    • Get available numbers via GET /api/v1/account/verified-cli/
  • enabled: Optional boolean to enable/disable trunk (default: True)
  • area_code: Optional area code for geographic routing
  • description: Optional description to identify the trunk
  • hide_caller_id: Optional boolean to hide caller ID on outbound calls (default: False)
    • When enabled, all outbound calls will appear as private number
    • Note: This may affect international call connectivity and reliability
  • sms_sender: Optional SMS sender number
    • Must start with '614'
    • Must be pre-verified for your account
    • This number will be displayed when sending SMS from CrazyPhone Softphone
    • Using the same SMS sender across multiple SIP trunks enables SMS synchronization
      between all CrazyPhone instances using that number
    • Get available numbers via GET /api/v1/account/verified-cli/
  • softphone_show_balance: Optional boolean to display balance in CrazyPhone (default: True)
  • softphone_sync_sms: Optional boolean to enable SMS synchronization in CrazyPhone (default: False)
    • When enabled, SMS messages will sync across all SIP trunks using the same SMS sender number

Returns

Newly created SIP trunk object including the automatically generated username

Raises

  • 400 - If caller ID or SMS sender is not verified or SMS sender format is invalid
  • 401 - If user is not authenticated
  • 422 - If password format does not meet requirements
  • 500 - If there is an error communicating with the Crazytel API
Language
Credentials
Header
Click Try It! to start a request and see the response here!