This page describes the data types that are specific to the UnifiedAPI.

UnifiedAPI uses the data types defined by the OpenSocial standard and extends them with the ones described below. For the full list of data types, please check out the Data Types section of the standard.

UAPI-Caller-Id

This data type is used when sending the caller name and phone number to the Service.

UAPI-Caller-Id = *( ALPHA / DIGIT / "<" / ">" / "+" / "*" )

UAPI-Extension-Number

This data type is used to identify the format of the extension numbers.

UAPI-Extension-Number = *( DIGIT / "*" ) / "@self"

The reserved values are defined below:

ValueDescription
@selfThe extension number is always assigned to a User, so @self matches all the extensions under that User.

UAPI-Phone-Number

This data type is used when sending a public phone number to the Service.

UAPI-Phone-Number = *( DIGIT / "+" )

UAPI-Agent-ID

This data type is used to identify the queue agents.

UAPI-Agent-ID = *( DIGIT / "*" ) / *( DIGIT / "+" )

HTTP Return Codes

Quick Examples

API Client