SipRouting Service (preview:2024-11-15)

2025/02/14 • 3 new methods

SipRouting_Get (new)
Description :  Gets SIP configuration for resource.
Reference :  Link ¶

⚼ Request

GET:  /sip
{
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
expand:
{
Description: Sip configuration expand. Optional. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
domains:
{
Description: Validated Domains. Map key is domain. ,
Required: False ,
}
object ,
trunks:
{
Description: SIP trunks for routing calls. Map key is trunk's FQDN (1-249 characters). ,
Required: False ,
}
object ,
routes:
{
Description: Trunk routes for routing calls. ,
Required: False ,
}
[
{
description:
{
Description: Gets or sets description of the route. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets name of the route. ,
Required: True ,
}
string ,
numberPattern:
{
Description: Gets or sets regex number pattern for routing calls. .NET regex format is supported. The regex should match only digits with an optional '+' prefix without spaces. I.e. "^\+[1-9][0-9]{3,23}$". ,
Required: True ,
}
string ,
trunks:
{
Description: Gets or sets list of SIP trunks for routing calls. Trunks are represented as FQDN. ,
Required: False ,
}
[
string ,
]
,
callerIdOverride:
{
Description: Gets or sets caller ID override. This value will override caller ID of outgoing call specified at runtime. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code ,
}
string ,
}
,
$schema:
{
Description: The Communication Services error. ,
}
{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
SipRouting_Update (new)
Description :  Updates SIP configuration for resource.
Reference :  Link ¶

⚼ Request

PATCH:  /sip
{
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
body:
{
Description: Sip configuration update object. ,
Required: False ,
}
{
domains:
{
Description: Domains that will be used. Map key is domain. ,
Required: False ,
}
object ,
trunks:
{
Description: SIP trunks for routing calls. Map key is trunk's FQDN (1-249 characters). ,
Required: False ,
}
object ,
routes:
{
Description: Trunk routes for routing calls. ,
Required: False ,
}
[
{
description:
{
Description: Gets or sets description of the route. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets name of the route. ,
Required: True ,
}
string ,
numberPattern:
{
Description: Gets or sets regex number pattern for routing calls. .NET regex format is supported. The regex should match only digits with an optional '+' prefix without spaces. I.e. "^\+[1-9][0-9]{3,23}$". ,
Required: True ,
}
string ,
trunks:
{
Description: Gets or sets list of SIP trunks for routing calls. Trunks are represented as FQDN. ,
Required: False ,
}
[
string ,
]
,
callerIdOverride:
{
Description: Gets or sets caller ID override. This value will override caller ID of outgoing call specified at runtime. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
domains:
{
Description: Validated Domains. Map key is domain. ,
Required: False ,
}
object ,
trunks:
{
Description: SIP trunks for routing calls. Map key is trunk's FQDN (1-249 characters). ,
Required: False ,
}
object ,
routes:
{
Description: Trunk routes for routing calls. ,
Required: False ,
}
[
{
description:
{
Description: Gets or sets description of the route. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets name of the route. ,
Required: True ,
}
string ,
numberPattern:
{
Description: Gets or sets regex number pattern for routing calls. .NET regex format is supported. The regex should match only digits with an optional '+' prefix without spaces. I.e. "^\+[1-9][0-9]{3,23}$". ,
Required: True ,
}
string ,
trunks:
{
Description: Gets or sets list of SIP trunks for routing calls. Trunks are represented as FQDN. ,
Required: False ,
}
[
string ,
]
,
callerIdOverride:
{
Description: Gets or sets caller ID override. This value will override caller ID of outgoing call specified at runtime. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code ,
}
string ,
}
,
$schema:
{
Description: The Communication Services error. ,
}
{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
SipRouting_TestRoutesWithNumber (new)
Description :  Gets the list of routes matching the target phone number, ordered by priority.
Reference :  Link ¶

⚼ Request

POST:  /sip:testRoutesWithNumber
{
targetPhoneNumber:
{
Description: Phone number to test routing patterns against ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
sipConfiguration:
{
Description: Sip configuration object to test with targetPhoneNumber. ,
Required: False ,
}
{
domains:
{
Description: Validated Domains. Map key is domain. ,
Required: False ,
}
object ,
trunks:
{
Description: SIP trunks for routing calls. Map key is trunk's FQDN (1-249 characters). ,
Required: False ,
}
object ,
routes:
{
Description: Trunk routes for routing calls. ,
Required: False ,
}
[
{
description:
{
Description: Gets or sets description of the route. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets name of the route. ,
Required: True ,
}
string ,
numberPattern:
{
Description: Gets or sets regex number pattern for routing calls. .NET regex format is supported. The regex should match only digits with an optional '+' prefix without spaces. I.e. "^\+[1-9][0-9]{3,23}$". ,
Required: True ,
}
string ,
trunks:
{
Description: Gets or sets list of SIP trunks for routing calls. Trunks are represented as FQDN. ,
Required: False ,
}
[
string ,
]
,
callerIdOverride:
{
Description: Gets or sets caller ID override. This value will override caller ID of outgoing call specified at runtime. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
matchingRoutes:
{
Description: The list of routes whose number patterns are matched by the target number. The routes are displayed and apply in the same order as in SipConfiguration. ,
Required: False ,
}
[
{
description:
{
Description: Gets or sets description of the route. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets name of the route. ,
Required: True ,
}
string ,
numberPattern:
{
Description: Gets or sets regex number pattern for routing calls. .NET regex format is supported. The regex should match only digits with an optional '+' prefix without spaces. I.e. "^\+[1-9][0-9]{3,23}$". ,
Required: True ,
}
string ,
trunks:
{
Description: Gets or sets list of SIP trunks for routing calls. Trunks are represented as FQDN. ,
Required: False ,
}
[
string ,
]
,
callerIdOverride:
{
Description: Gets or sets caller ID override. This value will override caller ID of outgoing call specified at runtime. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}