--- title: "Create a provider" method: POST path: "/providers" tags: ["Trunk"] --- # Create a provider `POST /providers` ## Request - Base URL: `https://HOSTNAME:8887/api` - URL: `https://HOSTNAME:8887/api/providers` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Add a new provider into system. ## Request body - object - `name` string, required: The name of the trunk. - `enabled` boolean: Whether to enable the provider. - `brand` string: The brand of trunk. - `auth_mode` 'IP_AUTH' | 'REGISTER_AUTH' | 'ACCEPT_REGISTER' | 'TEAMS' | 'WHATS_APP': Authentication mode: Can be either: - `IP_AUTH`: - `REGISTER_AUTH`: - `ACCEPT_REGISTER`: - `TEAMS`: - `WHATS_APP`: - `transport` 'UDP' | 'TCP' | 'TLS', required: The trunk transport protocol: Can be either: - `UDP`: - `TCP`: - `TLS`: - `hostname` string, required: Server hostname or IP address - `port` integer, required: A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port - `auth_id` string: Authentication ID, i.e. SIP username. - `username` string: Authentication username. - `password` string: Password for authentication. - `registration` boolean: Whether registration is required. - `register_interval` integer: Interval for registry refreshment, in seconds. - `outbound_server` string, required: The outbound server hostname of the trunk. - `outbound_server_port` integer, required: A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port - `inlan` boolean: Whether the trunk under LAN or not. - `single_via_header` boolean: Whether this trunk is only accept single Via SIP header or not. - `rewrite_via_ip` boolean: Rewrite the host IP of Via header by public IP when sending the request to trunk. - `verify_port` boolean: Verify the port when receiving SIP messages from trunk - `keep_alive` boolean: Send `OPTIONS` message for keep alive. - `concurrency` integer, required: The max number of concurrent calls. - `keep_alive_interval` integer: Keep alive message sending interval (seconds). - `additional_ips` string: The additional IP addresses of provider. A semicolon-separated list of IP addresses in CIDR format. For example: 192.0.2.0/24;192.0.2.0/32 as defined in RFC 4632 and RFC 4291. - `adjust_sdp_direction` boolean: Adjust the SDP direction for call hold. - `remove_srtp_info` boolean: Remove crypto line in the SDP. - `stir_shaken_signature_required` boolean: Whether to enable STIR/SHAKEN signature. - `did_numbers` string: The semicolon-separated list of DID/DDI pool number range or DID/DDI number. Assign a DID/DDI pool number range or DID/DDI number to the tenant. For example: 3000;12000-18000. The DID/DDI pool number range should not overlap with other tenant DID/DDI pool number ranges and numbers. - `inbound_parameters` object - `caller_num` 'REQUEST_LINE_URI_USER_PART' | 'CONTACT_USER_PART' | 'TO_DISPLAY_NAME' | 'TO_USER_PART' | 'FROM_DISPLAY_NAME' | 'FROM_USER_PART' | 'REMOTE_PARTY_ID_CALLED_PARTY_DISPLAY_NAME' | 'REMOTE_PARTY_ID_CALLED_PARTY_USER_PART' | 'REMOTE_PARTY_ID_CALLING_PARTY_DISPLAY_NAME' | 'REMOTE_PARTY_ID_CALLING_PARTY_USER_PART' | 'P_ASSERTED_IDENTITY_DISPLAY_NAME' | 'P_ASSERTED_IDENTITY_USER_PART' | 'P_PREFERRED_IDENTIFY_DISPLAY_NAME' | 'P_PREFERRED_IDENTIFY_USER_PART' | 'P_CALLED_PARTY_ID_DISPLAY_NAME' | 'P_CALLED_PARTY_ID_USER_PART' | 'DEFAULT': Inbound parameters: - `REQUEST_LINE_URI_USER_PART`: - `CONTACT_USER_PART`: - `TO_DISPLAY_NAME`: - `TO_USER_PART`: - `FROM_DISPLAY_NAME`: - `FROM_USER_PART`: - `REMOTE_PARTY_ID_CALLED_PARTY_DISPLAY_NAME`: - `REMOTE_PARTY_ID_CALLED_PARTY_USER_PART`: - `REMOTE_PARTY_ID_CALLING_PARTY_DISPLAY_NAME`: - `REMOTE_PARTY_ID_CALLING_PARTY_USER_PART`: - `P_ASSERTED_IDENTITY_DISPLAY_NAME`: - `P_ASSERTED_IDENTITY_USER_PART`: - `P_PREFERRED_IDENTIFY_DISPLAY_NAME`: - `P_PREFERRED_IDENTIFY_USER_PART`: - `P_CALLED_PARTY_ID_DISPLAY_NAME`: - `P_CALLED_PARTY_ID_USER_PART`: - `DEFAULT`: - `caller_display_name` 'REQUEST_LINE_URI_USER_PART' | 'CONTACT_USER_PART' | 'TO_DISPLAY_NAME' | 'TO_USER_PART' | 'FROM_DISPLAY_NAME' | 'FROM_USER_PART' | 'REMOTE_PARTY_ID_CALLED_PARTY_DISPLAY_NAME' | 'REMOTE_PARTY_ID_CALLED_PARTY_USER_PART' | 'REMOTE_PARTY_ID_CALLING_PARTY_DISPLAY_NAME' | 'REMOTE_PARTY_ID_CALLING_PARTY_USER_PART' | 'P_ASSERTED_IDENTITY_DISPLAY_NAME' | 'P_ASSERTED_IDENTITY_USER_PART' | 'P_PREFERRED_IDENTIFY_DISPLAY_NAME' | 'P_PREFERRED_IDENTIFY_USER_PART' | 'P_CALLED_PARTY_ID_DISPLAY_NAME' | 'P_CALLED_PARTY_ID_USER_PART' | 'DEFAULT': Inbound parameters: - `REQUEST_LINE_URI_USER_PART`: - `CONTACT_USER_PART`: - `TO_DISPLAY_NAME`: - `TO_USER_PART`: - `FROM_DISPLAY_NAME`: - `FROM_USER_PART`: - `REMOTE_PARTY_ID_CALLED_PARTY_DISPLAY_NAME`: - `REMOTE_PARTY_ID_CALLED_PARTY_USER_PART`: - `REMOTE_PARTY_ID_CALLING_PARTY_DISPLAY_NAME`: - `REMOTE_PARTY_ID_CALLING_PARTY_USER_PART`: - `P_ASSERTED_IDENTITY_DISPLAY_NAME`: - `P_ASSERTED_IDENTITY_USER_PART`: - `P_PREFERRED_IDENTIFY_DISPLAY_NAME`: - `P_PREFERRED_IDENTIFY_USER_PART`: - `P_CALLED_PARTY_ID_DISPLAY_NAME`: - `P_CALLED_PARTY_ID_USER_PART`: - `DEFAULT`: - `called_num` 'REQUEST_LINE_URI_USER_PART' | 'CONTACT_USER_PART' | 'TO_DISPLAY_NAME' | 'TO_USER_PART' | 'FROM_DISPLAY_NAME' | 'FROM_USER_PART' | 'REMOTE_PARTY_ID_CALLED_PARTY_DISPLAY_NAME' | 'REMOTE_PARTY_ID_CALLED_PARTY_USER_PART' | 'REMOTE_PARTY_ID_CALLING_PARTY_DISPLAY_NAME' | 'REMOTE_PARTY_ID_CALLING_PARTY_USER_PART' | 'P_ASSERTED_IDENTITY_DISPLAY_NAME' | 'P_ASSERTED_IDENTITY_USER_PART' | 'P_PREFERRED_IDENTIFY_DISPLAY_NAME' | 'P_PREFERRED_IDENTIFY_USER_PART' | 'P_CALLED_PARTY_ID_DISPLAY_NAME' | 'P_CALLED_PARTY_ID_USER_PART' | 'DEFAULT': Inbound parameters: - `REQUEST_LINE_URI_USER_PART`: - `CONTACT_USER_PART`: - `TO_DISPLAY_NAME`: - `TO_USER_PART`: - `FROM_DISPLAY_NAME`: - `FROM_USER_PART`: - `REMOTE_PARTY_ID_CALLED_PARTY_DISPLAY_NAME`: - `REMOTE_PARTY_ID_CALLED_PARTY_USER_PART`: - `REMOTE_PARTY_ID_CALLING_PARTY_DISPLAY_NAME`: - `REMOTE_PARTY_ID_CALLING_PARTY_USER_PART`: - `P_ASSERTED_IDENTITY_DISPLAY_NAME`: - `P_ASSERTED_IDENTITY_USER_PART`: - `P_PREFERRED_IDENTIFY_DISPLAY_NAME`: - `P_PREFERRED_IDENTIFY_USER_PART`: - `P_CALLED_PARTY_ID_DISPLAY_NAME`: - `P_CALLED_PARTY_ID_USER_PART`: - `DEFAULT`: - `privacy_types_supported` 'ID' | 'USER' | 'HEADER' | 'DEFAULT': Inbound parameters: - `ID`: id - `USER`: user - `HEADER`: header - `DEFAULT`: leave default value. - `enable_stir_shaken_validation` boolean: Enable STIR/SHAKEN validation or not. - `pai_header_parameter_name` string: The parameter name of PAI header. - `drop_calls_with_verification_status` string[]: A collection of verification status. Allowed values: `No-TN-Validation`, `TN-Validation-Failed`, `TN-Validation-Passed-B`, `TN-Validation-Passed-C`, `TN-Validation-Failed-A`, `TN-Validation-Failed-B`, `TN-Validation-Failed-C`. - `pass_api_header_to_uad` boolean: Enable STIR/SHAKEN validation or not. - `outbound_parameters` object - `request_line_uri_user_part` object - `value` 'AUTH_ID' | 'CALLER_NUM' | 'CALLED_NUM' | 'CALLER_DISPLAY_NAME' | 'OUTBOUND_CALLER_ID' | 'ORIGINATOR_CALLER_ID' | 'OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID' | 'ANONYMOUS' | 'DEFAULT' | 'CUSTOM': Inbound parameters: - `AUTH_ID`: - `CALLER_NUM`: - `CALLED_NUM`: - `CALLER_DISPLAY_NAME`: - `OUTBOUND_CALLER_ID`: - `ORIGINATOR_CALLER_ID`: - `OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID`: - `ANONYMOUS`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `request_line_uri_host_part` object - `value` 'TRUNK_HOST_PORT' | 'OUT_HOST_PORT' | 'CONTACT_URI' | 'SIP_DOMAIN' | 'DEFAULT' | 'CUSTOM': Inbound parameters variable: - `TRUNK_HOST_PORT`: - `OUT_HOST_PORT`: - `CONTACT_URI`: - `SIP_DOMAIN`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `contact_user_part` object - `value` 'AUTH_ID' | 'CALLER_NUM' | 'CALLED_NUM' | 'CALLER_DISPLAY_NAME' | 'OUTBOUND_CALLER_ID' | 'ORIGINATOR_CALLER_ID' | 'OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID' | 'ANONYMOUS' | 'DEFAULT' | 'CUSTOM': Inbound parameters: - `AUTH_ID`: - `CALLER_NUM`: - `CALLED_NUM`: - `CALLER_DISPLAY_NAME`: - `OUTBOUND_CALLER_ID`: - `ORIGINATOR_CALLER_ID`: - `OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID`: - `ANONYMOUS`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `contact_host_part` object - `value` 'TRUNK_HOST_PORT' | 'OUT_HOST_PORT' | 'CONTACT_URI' | 'SIP_DOMAIN' | 'DEFAULT' | 'CUSTOM': Inbound parameters variable: - `TRUNK_HOST_PORT`: - `OUT_HOST_PORT`: - `CONTACT_URI`: - `SIP_DOMAIN`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `to_display_name` object - `value` 'AUTH_ID' | 'CALLER_NUM' | 'CALLED_NUM' | 'CALLER_DISPLAY_NAME' | 'OUTBOUND_CALLER_ID' | 'ORIGINATOR_CALLER_ID' | 'OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID' | 'ANONYMOUS' | 'DEFAULT' | 'CUSTOM': Inbound parameters: - `AUTH_ID`: - `CALLER_NUM`: - `CALLED_NUM`: - `CALLER_DISPLAY_NAME`: - `OUTBOUND_CALLER_ID`: - `ORIGINATOR_CALLER_ID`: - `OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID`: - `ANONYMOUS`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `to_user_part` object - `value` 'AUTH_ID' | 'CALLER_NUM' | 'CALLED_NUM' | 'CALLER_DISPLAY_NAME' | 'OUTBOUND_CALLER_ID' | 'ORIGINATOR_CALLER_ID' | 'OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID' | 'ANONYMOUS' | 'DEFAULT' | 'CUSTOM': Inbound parameters: - `AUTH_ID`: - `CALLER_NUM`: - `CALLED_NUM`: - `CALLER_DISPLAY_NAME`: - `OUTBOUND_CALLER_ID`: - `ORIGINATOR_CALLER_ID`: - `OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID`: - `ANONYMOUS`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `to_host_part` object - `value` 'TRUNK_HOST_PORT' | 'OUT_HOST_PORT' | 'CONTACT_URI' | 'SIP_DOMAIN' | 'DEFAULT' | 'CUSTOM': Inbound parameters variable: - `TRUNK_HOST_PORT`: - `OUT_HOST_PORT`: - `CONTACT_URI`: - `SIP_DOMAIN`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `from_display_name` object - `value` 'AUTH_ID' | 'CALLER_NUM' | 'CALLED_NUM' | 'CALLER_DISPLAY_NAME' | 'OUTBOUND_CALLER_ID' | 'ORIGINATOR_CALLER_ID' | 'OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID' | 'ANONYMOUS' | 'DEFAULT' | 'CUSTOM': Inbound parameters: - `AUTH_ID`: - `CALLER_NUM`: - `CALLED_NUM`: - `CALLER_DISPLAY_NAME`: - `OUTBOUND_CALLER_ID`: - `ORIGINATOR_CALLER_ID`: - `OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID`: - `ANONYMOUS`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `from_user_part` object - `value` 'AUTH_ID' | 'CALLER_NUM' | 'CALLED_NUM' | 'CALLER_DISPLAY_NAME' | 'OUTBOUND_CALLER_ID' | 'ORIGINATOR_CALLER_ID' | 'OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID' | 'ANONYMOUS' | 'DEFAULT' | 'CUSTOM': Inbound parameters: - `AUTH_ID`: - `CALLER_NUM`: - `CALLED_NUM`: - `CALLER_DISPLAY_NAME`: - `OUTBOUND_CALLER_ID`: - `ORIGINATOR_CALLER_ID`: - `OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID`: - `ANONYMOUS`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `from_host_part` object - `value` 'TRUNK_HOST_PORT' | 'OUT_HOST_PORT' | 'CONTACT_URI' | 'SIP_DOMAIN' | 'DEFAULT' | 'CUSTOM': Inbound parameters variable: - `TRUNK_HOST_PORT`: - `OUT_HOST_PORT`: - `CONTACT_URI`: - `SIP_DOMAIN`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `remote_party_id_called_party_display_name` object - `value` 'AUTH_ID' | 'CALLER_NUM' | 'CALLED_NUM' | 'CALLER_DISPLAY_NAME' | 'OUTBOUND_CALLER_ID' | 'ORIGINATOR_CALLER_ID' | 'OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID' | 'ANONYMOUS' | 'DEFAULT' | 'CUSTOM': Inbound parameters: - `AUTH_ID`: - `CALLER_NUM`: - `CALLED_NUM`: - `CALLER_DISPLAY_NAME`: - `OUTBOUND_CALLER_ID`: - `ORIGINATOR_CALLER_ID`: - `OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID`: - `ANONYMOUS`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `remote_party_id_called_party_user_part` object - `value` 'AUTH_ID' | 'CALLER_NUM' | 'CALLED_NUM' | 'CALLER_DISPLAY_NAME' | 'OUTBOUND_CALLER_ID' | 'ORIGINATOR_CALLER_ID' | 'OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID' | 'ANONYMOUS' | 'DEFAULT' | 'CUSTOM': Inbound parameters: - `AUTH_ID`: - `CALLER_NUM`: - `CALLED_NUM`: - `CALLER_DISPLAY_NAME`: - `OUTBOUND_CALLER_ID`: - `ORIGINATOR_CALLER_ID`: - `OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID`: - `ANONYMOUS`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `remote_party_id_called_party_host_part` object - `value` 'TRUNK_HOST_PORT' | 'OUT_HOST_PORT' | 'CONTACT_URI' | 'SIP_DOMAIN' | 'DEFAULT' | 'CUSTOM': Inbound parameters variable: - `TRUNK_HOST_PORT`: - `OUT_HOST_PORT`: - `CONTACT_URI`: - `SIP_DOMAIN`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `remote_party_id_calling_party_display_name` object - `value` 'AUTH_ID' | 'CALLER_NUM' | 'CALLED_NUM' | 'CALLER_DISPLAY_NAME' | 'OUTBOUND_CALLER_ID' | 'ORIGINATOR_CALLER_ID' | 'OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID' | 'ANONYMOUS' | 'DEFAULT' | 'CUSTOM': Inbound parameters: - `AUTH_ID`: - `CALLER_NUM`: - `CALLED_NUM`: - `CALLER_DISPLAY_NAME`: - `OUTBOUND_CALLER_ID`: - `ORIGINATOR_CALLER_ID`: - `OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID`: - `ANONYMOUS`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `remote_party_id_calling_party_user_part` object - `value` 'AUTH_ID' | 'CALLER_NUM' | 'CALLED_NUM' | 'CALLER_DISPLAY_NAME' | 'OUTBOUND_CALLER_ID' | 'ORIGINATOR_CALLER_ID' | 'OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID' | 'ANONYMOUS' | 'DEFAULT' | 'CUSTOM': Inbound parameters: - `AUTH_ID`: - `CALLER_NUM`: - `CALLED_NUM`: - `CALLER_DISPLAY_NAME`: - `OUTBOUND_CALLER_ID`: - `ORIGINATOR_CALLER_ID`: - `OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID`: - `ANONYMOUS`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `remote_party_id_calling_party_host_part` object - `value` 'TRUNK_HOST_PORT' | 'OUT_HOST_PORT' | 'CONTACT_URI' | 'SIP_DOMAIN' | 'DEFAULT' | 'CUSTOM': Inbound parameters variable: - `TRUNK_HOST_PORT`: - `OUT_HOST_PORT`: - `CONTACT_URI`: - `SIP_DOMAIN`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `p_asserted_identity_display_name` object - `value` 'AUTH_ID' | 'CALLER_NUM' | 'CALLED_NUM' | 'CALLER_DISPLAY_NAME' | 'OUTBOUND_CALLER_ID' | 'ORIGINATOR_CALLER_ID' | 'OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID' | 'ANONYMOUS' | 'DEFAULT' | 'CUSTOM': Inbound parameters: - `AUTH_ID`: - `CALLER_NUM`: - `CALLED_NUM`: - `CALLER_DISPLAY_NAME`: - `OUTBOUND_CALLER_ID`: - `ORIGINATOR_CALLER_ID`: - `OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID`: - `ANONYMOUS`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `p_asserted_identity_user_part` object - `value` 'AUTH_ID' | 'CALLER_NUM' | 'CALLED_NUM' | 'CALLER_DISPLAY_NAME' | 'OUTBOUND_CALLER_ID' | 'ORIGINATOR_CALLER_ID' | 'OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID' | 'ANONYMOUS' | 'DEFAULT' | 'CUSTOM': Inbound parameters: - `AUTH_ID`: - `CALLER_NUM`: - `CALLED_NUM`: - `CALLER_DISPLAY_NAME`: - `OUTBOUND_CALLER_ID`: - `ORIGINATOR_CALLER_ID`: - `OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID`: - `ANONYMOUS`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `p_asserted_identity_host_part` object - `value` 'TRUNK_HOST_PORT' | 'OUT_HOST_PORT' | 'CONTACT_URI' | 'SIP_DOMAIN' | 'DEFAULT' | 'CUSTOM': Inbound parameters variable: - `TRUNK_HOST_PORT`: - `OUT_HOST_PORT`: - `CONTACT_URI`: - `SIP_DOMAIN`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `p_preferred_identify_display_name` object - `value` 'AUTH_ID' | 'CALLER_NUM' | 'CALLED_NUM' | 'CALLER_DISPLAY_NAME' | 'OUTBOUND_CALLER_ID' | 'ORIGINATOR_CALLER_ID' | 'OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID' | 'ANONYMOUS' | 'DEFAULT' | 'CUSTOM': Inbound parameters: - `AUTH_ID`: - `CALLER_NUM`: - `CALLED_NUM`: - `CALLER_DISPLAY_NAME`: - `OUTBOUND_CALLER_ID`: - `ORIGINATOR_CALLER_ID`: - `OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID`: - `ANONYMOUS`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `p_preferred_identify_user_part` object - `value` 'AUTH_ID' | 'CALLER_NUM' | 'CALLED_NUM' | 'CALLER_DISPLAY_NAME' | 'OUTBOUND_CALLER_ID' | 'ORIGINATOR_CALLER_ID' | 'OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID' | 'ANONYMOUS' | 'DEFAULT' | 'CUSTOM': Inbound parameters: - `AUTH_ID`: - `CALLER_NUM`: - `CALLED_NUM`: - `CALLER_DISPLAY_NAME`: - `OUTBOUND_CALLER_ID`: - `ORIGINATOR_CALLER_ID`: - `OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID`: - `ANONYMOUS`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `p_preferred_identify_host_part` object - `value` 'TRUNK_HOST_PORT' | 'OUT_HOST_PORT' | 'CONTACT_URI' | 'SIP_DOMAIN' | 'DEFAULT' | 'CUSTOM': Inbound parameters variable: - `TRUNK_HOST_PORT`: - `OUT_HOST_PORT`: - `CONTACT_URI`: - `SIP_DOMAIN`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `p_called_party_id_display_name` object - `value` 'AUTH_ID' | 'CALLER_NUM' | 'CALLED_NUM' | 'CALLER_DISPLAY_NAME' | 'OUTBOUND_CALLER_ID' | 'ORIGINATOR_CALLER_ID' | 'OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID' | 'ANONYMOUS' | 'DEFAULT' | 'CUSTOM': Inbound parameters: - `AUTH_ID`: - `CALLER_NUM`: - `CALLED_NUM`: - `CALLER_DISPLAY_NAME`: - `OUTBOUND_CALLER_ID`: - `ORIGINATOR_CALLER_ID`: - `OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID`: - `ANONYMOUS`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `p_called_party_id_user_part` object - `value` 'AUTH_ID' | 'CALLER_NUM' | 'CALLED_NUM' | 'CALLER_DISPLAY_NAME' | 'OUTBOUND_CALLER_ID' | 'ORIGINATOR_CALLER_ID' | 'OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID' | 'ANONYMOUS' | 'DEFAULT' | 'CUSTOM': Inbound parameters: - `AUTH_ID`: - `CALLER_NUM`: - `CALLED_NUM`: - `CALLER_DISPLAY_NAME`: - `OUTBOUND_CALLER_ID`: - `ORIGINATOR_CALLER_ID`: - `OUTBOUND_CALLER_ID_AND_ORIGINATOR_CALLER_ID`: - `ANONYMOUS`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `p_called_party_id_host_part` object - `value` 'TRUNK_HOST_PORT' | 'OUT_HOST_PORT' | 'CONTACT_URI' | 'SIP_DOMAIN' | 'DEFAULT' | 'CUSTOM': Inbound parameters variable: - `TRUNK_HOST_PORT`: - `OUT_HOST_PORT`: - `CONTACT_URI`: - `SIP_DOMAIN`: - `DEFAULT`: leave default value. - `CUSTOM`: - `custom_value` string: Custom value for the field. - `privacy_types_supported` object - `value` 'ID' | 'USER' | 'HEADER' | 'DEFAULT': Inbound parameters: - `ID`: id - `USER`: user - `HEADER`: header - `DEFAULT`: leave default value. ## Response `201` Created - object - `id` string: The unique ID of the resource. ## Other responses - `4XX`: Error --- [API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)