SBCs

Introduction

The SBC (Session Border Controller) is any network device that sends SIP INVITE messages to ClearIP. ClearIP uses the general term SBC to represent any SIP device, such as a softswitch, Private Branch eXchange (PBX) or SIP proxy. ClearIP only accepts SIP INVITEs from IP addresses that are configured as an SBC. Users may have multiple SBCs associated with their account. All other network traffic is refused by ClearIP with a SIP 403 Forbidden response.

Setup

Click the Organization tab and select the SBCs option to display the SBC screen. Click the Add button to fill out the form for adding SBCs.

SBCs Image

The Name and IP Address fields are the only fields that are required to be filled for all new SBC entries. All other fields are set to an initial default value. With the exception of the IP address and Partition fields, all other field values can be updated at any time if needed.

Note: It can take up to 60 seconds for changes to the SBCs page to take effect.

Name

The human readable display name. We recommend that the SBC display name be a meaningful name that is easy to remember.

IP Address

This is the public IP address of the SIP device used to send SIP signaling to ClearIP.

Partition

The subdomain of sip.clearip.com. Leave blank to apply to any subdomain or sip.clearip.com.

The Partition feature can be used to create multiple SBCs within ClearIP without requiring multiple public IP addresses reserved for each SBC. Instead of sending all calls to sip.clearip.com, you can send calls to different destinations of the form *.sip.clearip.com where * which is what we call the partition can be any text of your choosing. SBCs in ClearIP can be identified by a unique public IP address and partition pairing.

Here is an example of 2 SBCs that have been created. The SBCs have the same IP address with different partition values. SBC Partition

ClearIP checks for the partition in the SIP Invite request URI.

INVITE sip:16135550114@outbound.sip.clearip.com:5060 SIP/2.0
Via: SIP/2.0/TCP 192.168.1.89:3000;received=18.208.235.205;branch=z9hG4bK-27641-1-0
From: <sip:14047884802@192.168.1.89:3000>;tag=1
To: <sip:16135550114@1.2.3.4:5060>
Contact:  <sip:14047884802@192.168.1.89:3000>
Call-ID: 1-27641@192.168.1.89
CSeq: 1 INVITE
Max-Forwards: 69
Subject: Test
Content-Type: application/sdp
Content-Length: 0

ClearIP checks for both the partition and SBC IP address to match an SBC to a call. SBC Partition SIP Message

Status

If set to inactive, ClearIP will return a 403 “Forbidden” immediately. If set to blocked, ClearIP will return a 603 “Decline” immediately. The default value is Active.

No Fraud Detected Response Code

Response code to send when no fraud is detected. The default value is 503.

Most SBCs should use the SIP 503 code when no fraud is detected to allow route advance with some exceptions.

When ClearIP returns a SIP 503 response to certain SBCs, these SBCs tend to send multiple SIP Invites to ClearIP for each call attempt. When performing a DNS lookup and finding a list of multiple IP addresses, the SBCs send a SIP Invite to each IP address in the list instead of choosing a single IP address to send the call to. This has the effect of inflating the call volume seen by ClearIP which can impact billing. When ClearIP returns the SIP 404 response, then the SBC sends only a single SIP Invite per call attempt which is the desired behavior.

SBCs that require a SIP 404 for No Fraud Detected Response Code:

Metaswitch Perimeta SBC
Oracle SBC where routing is performed by the SBC and not the switch
Ribbon SWe SBC
Sonus 5400 SBC

Additional configuration may be needed to enable route advance on a SIP 404 response if it is not the default behavior.

Routing

Controls whether ClearIP uses the policies defined in the Routing menu for static or least cost routing. If set to No, then ClearIP ignore any policies defined in the Routing menu. If set to Yes, then ClearIP can return a SIP 302 response containing routes defined in the Routing menu. Defaults to No.

Include User Parameters In Routing Response

Whether or not request URI user parameters will be included in the routing response. The default value is No.

If ClearIP is configured to return a SIP 302 for routing and the SIP Invite contains a user parameter in the request URI that is required to be present in the redirect SIP Invite, then this field must be set to Yes.

Example SIP Invite with cic user parameter in request URI:

INVITE sip:8004444444;cic=0222@sip.clearip.com:5060;transport=tcp SIP/2.0
Via: SIP/2.0/TCP 20.20.20.20:5060;branch=z9hG4bK+0b99d7d09cf1db2a3b8d62a0c961c3681+sip+1+2c08b21e
From:  <sip:8122532170@10.195.1.4:5060;transport=tcp;otg=210>;tag=20.20.20.20+1+779a1ec+515d760;isup-oli=00
To:  <sip:8004444444@sip.clearip.com>
CSeq: 321587796 INVITE
Expires: 180
Content-Length: 171
Call-Info: <sip:20.20.20.20:5060>;method="NOTIFY;Event=telephone-event;Duration=2000"
Supported: resource-priority,siprec, 100rel
Contact:  <sip:e672268cbc6628d2121dd2e478cfb751@20.20.20.20>;isup-oli=00;attest=1
Content-Type: application/sdp
Allow-Events: message-summary, refer, dialog, line-seize, presence, call-info, as-feature-event, calling-name
Call-ID: 0gQAAC8WAAACBAAALxYAAMJIXvTO9VyNhieNBHOLUOU1UWDUhKC5intS+36ue88Q@20.20.20.20
Allow: INVITE, ACK, CANCEL, BYE, REGISTER, OPTIONS, PRACK, UPDATE, SUBSCRIBE, NOTIFY, REFER, INFO, PUBLISH
Max-Forwards: 66
P-Asserted-Identity: <sip:8122532170@10.195.1.4:5060>
Accept: application/sdp, application/dtmf-relay

Example SIP 302 returning cic user parameter in Contact header when field is set to Yes:

SIP/2.0 302 Moved Temporarily
Via: SIP/2.0/TCP 20.20.20.20:5060;branch=z9hG4bK+0b99d7d09cf1db2a3b8d62a0c961c3681+sip+1+2c08b21e
To:  <sip:8004444444@outbound.sip.clearip.com>;tag=ab032cd1-b3b1-406d-9d06-295f328ba7bd
From:  <sip:8122532170@10.195.1.4:5060;transport=tcp;otg=210>;tag=20.20.20.20+1+779a1ec+515d760;isup-oli=00
Call-ID: 0gQAAC8WAAACBAAALxYAAMJIXvTO9VyNhieNBHOLUOU1UWDUhKC5intS+36ue88Q@20.20.20.20
CSeq: 321587796 INVITE
Contact: <sip:8004444444;cic=0222@1.1.1.1;transport=udp>;q=0.99
Reason: SIP;cause=302;text="no-fraud-detected"
Content-Length: 0

This ensures the cic parameter is included in the redirected SIP Invite from the SBC to the external carrier.

By default, ClearIP only returns the called number in the Contact header without additional request URI user parameters in the SIP 302 response.

Return LRN In SIP Response

Whether or not NPDI and RN parameters will be returned in the SIP response. The default value is No.

Example SIP 302 response with LRN returned in the Contact header:

SIP/2.0 302 Moved Temporarily
Via: SIP/2.0/TCP 192.168.1.89:3000;received=18.208.235.205;branch=z9hG4bK-32761-1-0
To:  <sip:14047884802@1.2.3.4:5060>;tag=6e437109-3672-462b-afda-127404799f0b
From: <sip:14047884801@192.168.1.89:3000>;tag=1
Call-ID: 1-32761@192.168.1.89
CSeq: 1 INVITE
Contact: <sip:14047884802;npdi;rn=+14045679081@1.2.3.4:5060>;q=0.99
Reason: SIP;cause=302;text="no-fraud-detected"
Content-Length: 0

In this example, a call is made to called number 14047884802. ClearIP performed an LRN lookup to determine the number has been ported to LRN 14045679081.

ClearIP always does an LRN lookup for each call and uses the LRN for static and least cost routing decisions. This field does not impact ClearIP routing or whether ClearIP performs an LRN lookup.

Return IDs In SIP Response

Whether or not ClearIP IDs will be returned in the SIP response. The default value is No.

The IDs refer to the ClearIP ID values for the SIP Message, SBC, Service Provider, Group, and User for the call. These IDs can be used to reference the SIP Message, SBC, Service Provider, Group, and User using the ClearIP API.

Example SIP 302 response with IDs returned in X-Clearip-Id header:

SIP/2.0 302 Moved Temporarily
Via: SIP/2.0/TCP 192.168.1.89:3000;received=18.208.235.205;branch=z9hG4bK-15643-1-0
To: <sip:14047884801@1.2.3.4:5060>;tag=a0a30f91-3539-42f5-bba3-334f35a9d1f9
From: <sip:14047884802@192.168.1.89:3000>;tag=1
Call-ID: 1-15643@192.168.1.89
CSeq: 1 INVITE
X-Clearip-Id: a0a30f91-3539-42f5-bba3-334f35a9d1f9;sbc=046c16a2-647a-4d2f-b486-09fd7d34fefe;serviceProvider=175d515e-097a-49f8-b615-d1a132144668;group=b4bd2def-4668-4f5a-bbdf-b5586be1e07d;user=ad02c857-1d83-4a2d-ab50-46f06c502497
Contact: <sip:14047884801@1.2.3.4:5060>;q=0.99
Reason: SIP;cause=302;text="no-fraud-detected"
Content-Length: 0

From the example, the following IDs can be used with the ClearIP API:

SIP Message ID: a0a30f91-3539-42f5-bba3-334f35a9d1f9

SBC ID: 046c16a2-647a-4d2f-b486-09fd7d34fefe

Service Provider ID: 175d515e-097a-49f8-b615-d1a132144668

Group ID: b4bd2def-4668-4f5a-bbdf-b5586be1e07d

User ID: ad02c857-1d83-4a2d-ab50-46f06c502497

Return Rates In SIP Response

Whether or not billing and LCR rates will be returned in the SIP response. The default value is No.

ClearIP can return the LCR rate associated with each LCR destination within the SIP 302 response as parameters in the Contact header. If billing rates are configured, then ClearIP returns the billing rate in the X-Billing-Rate header.

SIP/2.0 302 Moved Temporarily
Via: SIP/2.0/TCP 192.168.1.89:3000;received=18.208.235.205;branch=z9hG4bK-15791-1-0
To: <sip:14047884801@1.2.3.4:5060>;tag=54181093-d731-434c-aef6-75dfc8b77e29
From: <sip:14047884802@192.168.1.89:3000>;tag=1
Call-ID: 1-15791@192.168.1.89
CSeq: 1 INVITE
X-Billing-Rate: 0.003
Contact: <sip:14047884801@1.1.1.1>;q=0.99;rate=0.00032, <sip:14047884801@2.2.2.2>;q=0.98;rate=0.0004
Reason: SIP;cause=302;text="no-fraud-detected"
Content-Length: 0

In the example, ClearIP returns a list of 2 LCR routes. As the first route, ClearIP selects the carrier with IP address 1.1.1.1 using the uploaded LCR rate of $0.00032 per minute. For the second route, ClearIP selects the carrier with IP address 2.2.2.2 using LCR rate of $0.0004 per minute.

If a static route defined within the Inbound or Outbound Routes is applied to the call, then ClearIP does not perform a LCR lookup and does not return an LCR rate in the SIP 302 response.

Return Reputation Score In SIP Response

Whether or not the calling number reputation score will be returned in the SIP response. The default value is No.

ClearIP can return the calling number reputation in a X-Reputation-Score header in the SIP 302 response.

SIP/2.0 302 Moved Temporarily
Via: SIP/2.0/TCP 192.168.1.89:3000;received=18.208.235.205;branch=z9hG4bK-15919-1-0
To: <sip:14047884802@1.2.3.4:5060>;tag=900aaf1f-1413-45da-a82c-0b8e82114821
From: <sip:16237453822@192.168.1.89:3000>;tag=1
Call-ID: 1-15919@192.168.1.89
CSeq: 1 INVITE
X-Reputation-Score: 100
Contact: <sip:14047884802@1.2.3.4:5060>;q=0.99
Reason: SIP;cause=302;text="no-fraud-detected"
Content-Length: 0

Return Verification Status In SIP Response

Whether or not the verification status will be returned in the SIP response. The default value is No.

ClearIP can return the STI Verification Status in the SIP 302 response in the X-Verification-Status header.

SIP/2.0 302 Moved Temporarily
Via: SIP/2.0/TCP 192.168.1.89:3000;received=18.208.235.205;branch=z9hG4bK-16043-1-0
To: <sip:14047884801@1.2.3.4:5060>;tag=db1ab6b4-4f25-4d48-bea0-be974366185c
From: <sip:14047884802@192.168.1.89:3000>;tag=1
Call-ID: 1-16043@192.168.1.89
CSeq: 1 INVITE
X-Verification-Status: successful
Contact: <sip:14047884801@1.2.3.4:5060>;q=0.99
Reason: SIP;cause=302;text="no-fraud-detected"
Content-Length: 0

Possible values:

successful
invalid-token-signature
certificate-chain-error
certificate-error
certificate-repository-error
called-number-mismatch
calling-number-mismatch
invalid-token-typ
invalid-token-ppt
invalid-token-alg
invalid-token-x5u
invalid-token-dest
invalid-token-orig
invalid-token-iat
invalid-token-origid
invalid-token-attestation-indicator
malformed-certificate-repository
malformed-token
invalid-parameter-ppt
invalid-parameter-alg
invalid-parameter-info
malformed-identity-header
no-identity-header
no-verification-requested

Return Authentication Status In SIP Response

Whether or not the authentication status will be returned in the SIP response. The default value is No.

ClearIP can return the STI Authentication Status in the SIP 302 response in the X-Authentication-Status header.

SIP/2.0 302 Moved Temporarily
Via: SIP/2.0/TCP 192.168.1.89:3000;received=18.208.235.205;branch=z9hG4bK-15938-1-0
To: <sip:14047884801@1.2.3.4:5060>;tag=a29ed450-87c4-4669-a69f-5b79e49f51eb
From: <sip:14047884802@192.168.1.89:3000>;tag=1
Call-ID: 1-15938@192.168.1.89
CSeq: 1 INVITE
Identity: eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9jZXJ0aWZpY2F0ZXMuY2xlYXJpcC5jb20vMWYzODgwMzAtNWQ5NS00NTU2LWJjZmMtMmYyMmRlNWM1MjcwLzQ0M2JhZGJhMTRlNGM0YzM3YzdlYzVkN2UwNGU1OGRmMTA3MGZmMTgxZjE5Y2FiYmY4MGJiM2ZlODI3OTZmNTAuY3J0In0.eyJhdHRlc3QiOiJBIiwiZGVzdCI6eyJ0biI6WyIxNDA0Nzg4NDgwMSJdfSwiaWF0IjoxNjE5MjgwNTY4LCJvcmlnIjp7InRuIjoiMTQwNDc4ODQ4MDIifSwib3JpZ2lkIjoiYTI5ZWQ0NTAtODdjNC00NjY5LWE2OWYtNWI3OWU0OWY1MWViIiwicmNkIjp7Im5hbSI6IlJDRCBOYW1lIFRlc3QifX0.gbx97dg0jH6rk_7wxQ1zXKvLUWBsQiaNRS-hThXd3LJhG1jEvS0hhMagevaV9ICe4r1fOfgwqJnRb6DJxxy1eA;info=<https://certificates.clearip.com/1f388030-5d95-4556-bcfc-2f22de5c5270/443badba14e4c4c37c7ec5d7e04e58df1070ff181f19cabbf80bb3fe82796f50.crt>;alg=ES256;ppt=shaken
X-Authentication-Status: successful
Contact: <sip:14047884801@1.2.3.4:5060>;q=0.99
Reason: SIP;cause=302;text="no-fraud-detected"
Content-Length: 0

Possible values:

successful
blocked
no-authority
invalid-calling-number
invalid-called-number
ignored
no-authentication-requested

CNAM Maximum Length

The maximum length caller display name to return. Longer values will be truncated to this length. The default value is 15.

CNAM Header

The header used to return the CNAM token. The default value is P-Asserted-Identity.

P-Asserted-Identity:

SIP/2.0 302 Moved Temporarily
Via: SIP/2.0/TCP 192.168.1.89:3000;received=18.208.235.205;branch=z9hG4bK-16194-1-0
To: <sip:14047884802@1.2.3.4:5060>;tag=cb1fbddd-697d-4f7c-9ddd-f9e85cbfc92a
From: <sip:14045266060@192.168.1.89:3000>;tag=1
Call-ID: 1-16194@192.168.1.89
CSeq: 1 INVITE
P-Asserted-Identity: "TRANSNEXUS" <sip:14045266060@192.168.1.89:3000>
Contact: <sip:14047884802@1.2.3.4:5060>;q=0.99
Reason: SIP;cause=302;text="no-fraud-detected"
Content-Length: 0

X-Asserted-Identity:

X-Asserted-Identity: "TRANSNEXUS" <sip:14045266060@192.168.1.89:3000>

P-Asserted-Identity Embedded in Contact URI:

Contact: <sip:14047884802@1.2.3.4:5060?P-Asserted-Identity=%22TRANSNEXUS%22%20%3Csip%3A14045266060%40192.168.1.89%3A3000%3E>;q=0.99

The P-Asserted-Identity Embedded in Contact URI value is used to return CNAM for the Metaswitch Perimeta SBC, BroadWorks, and Oracle SBC.

X-Asserted-Identity Embedded in Contact URI:

Contact: <sip:14047884802@1.2.3.4:5060?X-Asserted-Identity=%22TRANSNEXUS%22%20%3Csip%3A14045266060%40192.168.1.89%3A3000%3E>;q=0.99

P-Asserted-Identity Embedded in Contact:

Contact: <sip:14047884802@1.2.3.4:5060>;q=0.99?P-Asserted-Identity=%22TRANSNEXUS%22%20%3Csip%3A14045266060%40192.168.1.89%3A3000%3E

The P-Asserted-Identity Embedded in Contact value can be used to return CNAM for the Sansay VSXi SBC.

X-Asserted-Identity Embedded in Contact:

Contact: <sip:14047884802@1.2.3.4:5060>;q=0.99?X-Asserted-Identity=%22TRANSNEXUS%22%20%3Csip%3A14045266060%40192.168.1.89%3A3000%3E

Identity Header

The header used to return the Identity token. The default value is Identity.

Identity:

SIP/2.0 302 Moved Temporarily
Via: SIP/2.0/TCP 192.168.1.89:3000;received=18.208.235.205;branch=z9hG4bK-7156-1-0
To: <sip:14047884802@1.2.3.4:5060>;tag=080b1aa9-b725-4952-8556-aaa5874dbfce
From: <sip:14045266060@192.168.1.89:3000>;tag=1
Call-ID: 1-7156@192.168.1.89
CSeq: 1 INVITE
Identity: eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9jZXJ0aWZpY2F0ZXMuY2xlYXJpcC5jb20vdHJhbnNuZXh1cy9mYWQ0YzA3ODg4YzBmMWQzZGUxMTE1ZGNiM2FkODJiZC5jcnQifQ.eyJhdHRlc3QiOiJDIiwiZGVzdCI6eyJ0biI6WyIxNDA0Nzg4NDgwMiJdfSwiaWF0IjoxNjE5NDY5NzIwLCJvcmlnIjp7InRuIjoiMTQwNDUyNjYwNjAifSwib3JpZ2lkIjoiMDgwYjFhYTktYjcyNS00OTUyLTg1NTYtYWFhNTg3NGRiZmNlIn0.xVBEsB8gnnIP6gNw51-H43SCQrzqGq-0mojZ7jo6XA7in73_wz_DRIo_Jbw8los_5izUCsRjtqM-90cKTjHwsQ;info=<https://certificates.clearip.com/transnexus/fad4c07888c0f1d3de1115dcb3ad82bd.crt>;alg=ES256;ppt=shaken
Contact: <sip:14047884802@1.2.3.4:5060>;q=0.99
Reason: SIP;cause=302;text="no-fraud-detected"
Content-Length: 0

The default Identity value can be used for ClearIP to return a standard Identity header. This value should be used for most platforms including netsapiens unless specified below.

X-Identity:

X-Identity: eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9jZXJ0aWZpY2F0ZXMuY2xlYXJpcC5jb20vdHJhbnNuZXh1cy9mYWQ0YzA3ODg4YzBmMWQzZGUxMTE1ZGNiM2FkODJiZC5jcnQifQ.eyJhdHRlc3QiOiJDIiwiZGVzdCI6eyJ0biI6WyIxNDA0Nzg4NDgwMiJdfSwiaWF0IjoxNjE5NDY5ODAwLCJvcmlnIjp7InRuIjoiMTQwNDUyNjYwNjAifSwib3JpZ2lkIjoiMTA2ZGMxZjMtMjgyMy00YjNjLWE3YzgtZWE3OWQ5ZmZmZDA1In0.Ar4Qqty5k-BsBTfYemmfIfYNguOsWm2u-to4D5ErN6s4CEuSCAntKJPb2KVv7xl8NkuSimW2_fq4-iOWg9N61A;info=<https://certificates.clearip.com/transnexus/fad4c07888c0f1d3de1115dcb3ad82bd.crt>;alg=ES256;ppt=shaken

The X-Identity value can be used to return the Identity header for the ClearIP In-line proxy.

Identity Embedded in Contact URI:

Contact: <sip:14047884802@1.2.3.4:5060?Identity=eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9jZXJ0aWZpY2F0ZXMuY2xlYXJpcC5jb20vdHJhbnNuZXh1cy9mYWQ0YzA3ODg4YzBmMWQzZGUxMTE1ZGNiM2FkODJiZC5jcnQifQ.eyJhdHRlc3QiOiJDIiwiZGVzdCI6eyJ0biI6WyIxNDA0Nzg4NDgwMiJdfSwiaWF0IjoxNjE5NDY5ODc4LCJvcmlnIjp7InRuIjoiMTQwNDUyNjYwNjAifSwib3JpZ2lkIjoiMzBkMTgxNjMtNzhjNi00OGY4LWIwODQtMTUwOWZmODIzOGE4In0.Bl2A8o9ioJXd1vUp7xSQvb-GDH2JTh4ZwIFL7cifLlosTqSjlxH2cHVYgxRw3-FB1BnllFFXfpp49NkHuz7-BQ%3Binfo%3D%3Chttps%3A%2F%2Fcertificates.clearip.com%2Ftransnexus%2Ffad4c07888c0f1d3de1115dcb3ad82bd.crt%3E%3Balg%3DES256%3Bppt%3Dshaken>;q=0.99

The Identity Embedded in Contact URI value can be used to return the Identity header for the Metaswitch Perimeta SBC, BroadWorks, and Oracle SBC if using the embedded header mechanism.

X-Identity Embedded in Contact URI:

Contact: <sip:14047884802@1.2.3.4:5060?X-Identity=eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9jZXJ0aWZpY2F0ZXMuY2xlYXJpcC5jb20vdHJhbnNuZXh1cy9mYWQ0YzA3ODg4YzBmMWQzZGUxMTE1ZGNiM2FkODJiZC5jcnQifQ.eyJhdHRlc3QiOiJDIiwiZGVzdCI6eyJ0biI6WyIxNDA0Nzg4NDgwMiJdfSwiaWF0IjoxNjE5NDY5OTE5LCJvcmlnIjp7InRuIjoiMTQwNDUyNjYwNjAifSwib3JpZ2lkIjoiMWM3YzliZWEtMjRjMi00NDUyLTgxMzEtODk1YjcxY2NhZjk0In0.mMq3V9GmuIGyesSwKhj1LL5iEtRqlHUDHXkNU_64Aah5HgDNh2p982kZC8sx8JNMabwLs9ElZZ1vWvlOjFqpwg%3Binfo%3D%3Chttps%3A%2F%2Fcertificates.clearip.com%2Ftransnexus%2Ffad4c07888c0f1d3de1115dcb3ad82bd.crt%3E%3Balg%3DES256%3Bppt%3Dshaken>;q=0.99

Identity Embedded in Contact:

Contact: <sip:14047884802@1.2.3.4:5060>;q=0.99?Identity=eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9jZXJ0aWZpY2F0ZXMuY2xlYXJpcC5jb20vdHJhbnNuZXh1cy9mYWQ0YzA3ODg4YzBmMWQzZGUxMTE1ZGNiM2FkODJiZC5jcnQifQ.eyJhdHRlc3QiOiJDIiwiZGVzdCI6eyJ0biI6WyIxNDA0Nzg4NDgwMiJdfSwiaWF0IjoxNjE5NDY5OTU1LCJvcmlnIjp7InRuIjoiMTQwNDUyNjYwNjAifSwib3JpZ2lkIjoiOGMzZmU3MGItNGEzMi00MmZmLThhYjgtM2VjZWE0OWZmYjZiIn0.joNYvSrZ9aBOZ3rpZqntiTK4clToY4pyjPTAq3f1EXmLmIDgMAijkPg73Rfff1qC1G1SSAQ09WMA-Tlt5cO0SQ%3Binfo%3D%3Chttps%3A%2F%2Fcertificates.clearip.com%2Ftransnexus%2Ffad4c07888c0f1d3de1115dcb3ad82bd.crt%3E%3Balg%3DES256%3Bppt%3Dshaken

X-Identity Embedded in Contact:

Contact: <sip:14047884802@1.2.3.4:5060>;q=0.99?X-Identity=eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9jZXJ0aWZpY2F0ZXMuY2xlYXJpcC5jb20vdHJhbnNuZXh1cy9mYWQ0YzA3ODg4YzBmMWQzZGUxMTE1ZGNiM2FkODJiZC5jcnQifQ.eyJhdHRlc3QiOiJDIiwiZGVzdCI6eyJ0biI6WyIxNDA0Nzg4NDgwMiJdfSwiaWF0IjoxNjE5NDY5OTk2LCJvcmlnIjp7InRuIjoiMTQwNDUyNjYwNjAifSwib3JpZ2lkIjoiNjQyNzFkN2MtNzJmNS00ZjgzLTgxMzAtOTkwZmVmZTIxOTgzIn0.LENrd5tlCv1HzT5UfsihVPwfHkNZHB2cRV9-oApfzba-oTI6awTodzFq2ciXqIl_4cvmTj8gqPB7UVsGxGygVA%3Binfo%3D%3Chttps%3A%2F%2Fcertificates.clearip.com%2Ftransnexus%2Ffad4c07888c0f1d3de1115dcb3ad82bd.crt%3E%3Balg%3DES256%3Bppt%3Dshaken

Local Routing Algorithm

The algorithm used to determine if a call is local. The default value is Intra Rate Center.

Diversion Destination

The destination diverted calls will be sent to. The default value is captcha.clearip.com:5060;transport=tcp.

A diversion destination can be configured by adding an IP address, FQDN, or trunk group using the same formats as used for ClearIP static and least cost routing.

Example SIP 302 redirecting call to ClearIP CAPTCHA:

SIP/2.0 302 Moved Temporarily
Via: SIP/2.0/TCP 1.1.1.1:5060;received=1.1.1.1;branch=z9hG4bK3184ADE92A183D095DEC89831EF2F731;rport=40826
To:  <sip:+18324108099@1.1.1.1>;tag=764cf0e4-cfde-4a19-8893-6e373a44646e
From:  <sip:+18324108099@2.2.2.2>;tag=F1FD3030333033302D766800
Call-ID: 021298ED8B8140000000E6F4@TCP5060
CSeq: 1 INVITE
Contact:  <sip:+18324108099@captcha.clearip.com:5060;transport=tcp;id=764cf0e4-cfde-4a19-8893-6e373a44646e>;q=0.99
Reason: SIP;cause=302;text="diverted"
Content-Length: 0

Static Destination

The static destination all calls will be sent to.

If a static destination is configured, then ClearIP returns the destination within the SIP 302 Contact header. If static or least cost routing are configured, then ClearIP returns the static or least cost routes if available instead of the static route.

This can be used to configure ClearIP to return the internal IP address of the switch in the SIP 302 response sent to the SBC to implement a hairpin call flow. For the hairpin scenario, the SBC must be configured to recurse on a SIP 302 to redirect the SIP Invite to the switch’s internal signaling IP address.

Example SIP 302 with static destination set to internal IP address 192.168.5.5:

SIP/2.0 302 Moved Temporarily
Via: SIP/2.0/TCP 192.168.1.89:3000;received=18.208.235.205;branch=z9hG4bK-7353-1-0
To: <sip:14047884802@1.2.3.4:5060>;tag=d59d2d8f-cbe6-4564-baaa-daea59553651
From: <sip:14045266060@192.168.1.89:3000>;tag=1
Call-ID: 1-7353@192.168.1.89
CSeq: 1 INVITE
Contact: <sip:14047884802@192.168.5.5>;q=0.99
Reason: SIP;cause=302;text="no-fraud-detected"
Content-Length: 0

Minimum Calling Number Length

The minimum length a calling number must be to be processed by ClearIP. If the calling number is shorter than this length, ClearIP will return a 484 “Address Incomplete” response immediately. Set this to 0 to have no minimum length. The default value is 0.

This can be used to prevent local calls and calls to extension numbers from being processed. If all calls should be processed by ClearIP, set minimum length to zero.

Minimum Called Number Length

The minimum length a called number must be to be processed by ClearIP. If the called number is shorter than this length, ClearIP will return a 484 “Address Incomplete” response immediately. Set this to 0 to have no minimum length. The default value is 0.

This can be used to prevent local calls and calls to extension numbers from being processed. If all calls should be processed by ClearIP, set minimum length to zero.