Sinch Community

This article details the steps required to set up RCS for use with Sinch Conversation API.    Prerequisites    Before you can set up an RCS channel on the Conversation API, you need to setup Conversation API.   Note: If you have already setup Conversation API by completing the Conversation API Getting started steps, you can skip this section.    To setup Conversation API take the following steps: Sign up for the Sinch Build Dashboard.  Get access to Conversation API.  Create your access key. Any API calls you make will require authentication information provided by your access key.  Refer to the Get access section of the Conversation API Getting started guide for more information on any of these steps.       Step 1 – Setup your RCS Agent   To start using RCS through Conversation API, you must register your RCS Sender Agent (or RCS Agent). Watch this video to learn how to set up and launch your RCS Agent:     All the steps are outlined in detail in the step-by-step guide below.   Setting up your RCS Agent step-by-step guide:   Log in to the Sinch Build Dashboard and select the Agents option from the RCS menu in the left panel. The RCS Business Messaging – Agents page is displayed:     This page contains important details about the information you need before you can create an RCS agent.   To create an RCS agent, follow the steps below:   Click Create agent. The Create agent form is displayed: Step 1. Agent details of this form contains the following sections XXXX: Name and description Enter a name and description for your agent which relates to your company as this information will be visible when users interact with the agent. Color & logo Style the look and feel of your agent by adding your company logo and brand colours. Agent contact information and policies Add important contact information for your business. Note:  Mandatory fields which must be completed are marked with an asterisk (*). As you fill out the form, the Agent previewer displayed on the right (outlined in blue above) will show you how this information will look in an RCS message. Once you have completed this section, click Continue to settings. The 2. Agent settings step of the form is displayed: This step allows you to further configure your agent: Conversation API app Select an existing Conversation API app or you can choose to create a new app, to connect to your agent.   Select the Use existing app radio button if you want to use an existing Conversation API app and then select the app you’d like to use from the drop-down list.   Select the Create new app radio button to create a new Conversation API app, then enter a name for the new app and select the region in which the app’s data will be hosted.   The RCS channel will be automatically activated for your specified Conversation API app, and your RCS agent will be automatically connected to the app once it has been created.   Warning:  If you plan to use an existing Conversation API app, your Conversation API App must have been created in the same region that your RCS Agent is provisioned. If your Conversation API App is created in a different region than the RCS Agent is provisioned, the RCS channel will report errors, and you won't receive your delivery receipts.   Countries Select one or more countries you want to send messages to using your agent. If the country, you want to send to is not listed it means that you cannot launch in that market yet. You may create an agent without selecting a country (select the Add countries later option) so you can test, but prior to launch you need to select a country.   Note: You can also select one country now and add more countries later as they become available. Agent purpose Select the billing category and use case for your agent.   Note: These can’t be changed after creating the agent. Refer to the Agent setting guide on the right panel for full details and explanations of the fields. Once you have completed this section, click Continue to settings.   The 3. Agent experience step of the form is displayed. Operators need to know how users interact with your agent. We have populated the form with our recommendations. If something doesn’t match your interactions feel free to make changes to suit your requirements. For certain countries, you need some special configurations to enable and setup RCS. You can add this information in the Country Specific questions section of the form.  Note: However, in some cases additional information is required for the network carrier(s). Sinch or the carrier may need to follow up with you directly to gather the required information or you may need to complete another task, like sending an email. Each carrier has their own time frame for approving agents. Once you have completed this section, click Continue to summary. The 4. Agent summary step of the form is displayed: This shows you a summary of your RCS agent. Carefully review the information you have entered. To make any changes, click the Edit button. To create your agent, click Create agent. Your agent will be created, and a confirmation message is displayed:     Step 2 – Test your agent prior to launching your agent   Important Note: To test RCS, you need to have a recipient device (mobile handset) that supports RCS for Business. Your ability to test may also be dependent on your carrier. If you encounter any issues, please reach out to your Account Manager.   To test your agent, follow the simple steps below:   To ensure that everything has been setup correctly you can send a test message: Click Test agent now. The Add test number dialog is displayed. Enter a test number and click Continue:   An invitation from Google will be sent to your test number: Click Make me a tester. Google will send a confirmation message to your handset. The Capability check confirmation dialog will be displayed on the Build Dashboard: Click Continue. The Send a test message dialog is displayed: Select the type of message you want to send from the Message drop down. Click Send test message. The message will be sent to your test number. Once you have confirmed you have successfully received the test message you are ready to launch your agent!     Step 3 – Launch RCS Agent Note: If you’re looking to launch in an unavailable market (country), you will need to wait until that market becomes available.   To Launch the RCS Agent:   Return to the RCS->Agents page: Click Launch Agent. The Launch agent form is displayed: Complete the additional required fields with the requested information regarding your brand and contact details. Click Continue. The form is refreshed and a list of countries you have selected to send messages to is displayed along with details the countries where additional information is required: For example, to send messages to the United Kingdom, you are requested to complete the Additional requirements – United Kingdom section .In this case, completing the section entails using the details provided to send authorization emails to each of the various operators in the United Kingdom. Follow the instructions in the Additional requirements sections and once you have completed the requested actions, select the confirmation radio button to confirm you have done this. Click Launch Agent. The information you have provided will be submitted to Sinch. For some cases we can submit the information straight to Google. Google may follow up with the brand asking for consent to launch agent using Sinch. In such cases the launch agent process can take 2-3 days provided you respond with the requested information promptly. However, in many cases additional information is required for the carrier(s) and we will need to follow up directly with you to gather the required information. In some cases, the carrier may also follow up directly with you for additional information.   Once your RCS Agent has been successfully launched! Check with your Account Manager for confirmation or if you have any questions.      Step 4 – Set your channel priority   Conversation API allows you send messages across multiple messaging channels including RCS. If you have configured multiple channels on the Conversation API App, you can set the channel priority .    If your channel priority is already established or you already know how to set channel priority, you are now ready to go and you can start sending RCS messages!     Sending your first RCS messages  Once you receive confirmation that your RCS Agent has been successfully launched, you are ready to send RCS messages using the Conversation API: For a quick walkthrough that explains how to send RCS messages using the Conversation API (via Postman), see the second half of this video tutorial. For a more detailed procedure that explains how to send messages using the Conversation API, see our Getting Started guide for Conversation API. Select your preferred coding language and follow the corresponding instructions. Note that our Getting Started guides are preset to use the SMS channel; you’ll need to update the code snippets to use the RCS channel. Also, you won’t need to include the SMS sender value in your RCS code. For full details on sending messages using the Conversation API, refer to the API Reference Guide.    Support   Reach out to your Account Manager for more information or if you have questions. ... View more

The certificate chain file issued by Entrust Certificate Authority attached below should be added by customers to their certificate stores. This certificate chain is to be used along with service specific TLS certificates that are issued by Sinch for their services. ... View more

Watch the video to learn how to set up your RCS Business Agent from start to finish with this step-by-step walkthrough. Follow along as we cover agent customization, experience configuration, and testing. This comprehensive guide shows you the entire process from initial setup to successful deployment:     For full details of how to get started with RCS using Conversation API - refer to the article: Getting Started with RCS using Conversation API. ... View more

Watch the video below to learn everything you need to know about handling metadata in Conversation API:     This comprehensive tutorial breaks down how metadata works across messages, conversations, and contacts. You'll learn: Different types of metadata and their specific use cases How to attach and retrieve metadata in API requests Understanding metadata in callbacks and delivery receipts Working with Correlation IDs and channel-specific data Step-by-step guide to updating metadata for messages, conversations, and contacts. For more information on setting up Conversation API and all the channels it supports including RCS, SMS, WhatsApp, and more, view our Conversation API developer documentation. ... View more

Watch our video below to discover how RCS (Rich Communication Services) is expanding what's possible with business messaging by enabling more engaging, interactive, and secure customer experiences right in their native messaging inbox:     The video shows you: The difference between SMS, RCS, and RCS for Business What is RCS for Business and how does it work Interactive features that create app-like experiences How verified sender status protects your customers Simple steps to get started with RCS. To learn more about RCS, visit our website for guides, resources, and success stories: https://sinch.com/rcs/ ... View more

How do you register   With changes to the current messaging landscape, mobile carriers are now requiring any business users that send SMS/MMS messages over 10 digit numbers (A2P 10DLC) to have those numbers registered with an organization called The Campaign Registry (TCR): https://www.campaignregistry.com/.   The intent is to cut down on text message spam that has become a growing problem for their mobile customers. Registering with TCR allows TCR to review your use-case for what you intend to use messaging for, link the Brand (the business entity sending the messages) and the Campaigns (each specific use-case) with the CSP (Campaign Service Providers), along with the list of telephone numbers the messages will be sent from, all with the purpose of providing complete traceability back to the originator of any message. If your messages are determined to be non-compliant, the mobile carriers will happily send us a fine, which we will then pass on to you. Repeated non-compliance will result in the mobile carriers blocking your number completely from messaging.   In order to prevent the risk of financial penalties, we have taken the step of disabling all SMS/MMS messaging for use with officeXtend.   If you do want to keep sending messages external to your organization, these messages will be sent using SMS/MMS and require a registration with TCR. However, until the whole registration process is complete, we cannot enable you to send SMS/MMS messages.     Using officeXtend For Internal Messaging   As part of the recent change, we also enabled a feature in officeXtend where you can still send messages to other internal users within your own organization such that those messages do not traverse the SMS/MMS messaging gateways. To enable this feature, simply log out of your client and log back in. The messaging tab will be there, and you can send and receive normally within your organization.     Steps to Get Registered   Fortunately, as our customer, you don't need to do the registration process with TCR directly. We are your CSP (Campaign Service Provider) and will file your Brand and Campaign information for you with TCR. With that said, we will be asking a lot of information about your company, the intended uses for messaging and the list of phone numbers you'll be sending messages from. All of this information is REQUIRED by TCR to evaluate your request. They are trained to know what will pass the mobile carriers scrutiny in terms of your registration request. NOTE: Fees also apply to brand and campaign registrations. The fees are listed at the bottom of this article.   Cheat Sheet Form To start, we have a handy form here: A2P 10DLC Messaging Campaign Form This form contains all the information that we need to file your request with TCR.   Brand Information The first page is the Brand information. This is information about your company and should be pretty clear about what to fill out. A Brand can have multiple Campaigns if you have different use-cases that you use messaging for.   Campaign Information The second page is the Campaign you will be filing. Note that "Campaign" is used loosely here in that it's normally associated with a text message blast, but in the context of filing for messaging use-cases, it really means what is going to be the content of your messages. For officeXtend usage, the campaign choice really depends on how you are using the client to communicate with customers and most importantly, the content of those messages.   If you have a lot of time, here is a very detailed article on what is A2P 10 DLC messaging and all the related information, most of which you don't really need to know to complete the form. Everything You Wanted to Know About A2P 10DLC But Were Afraid To Ask It's a lot as the mobile carriers have made this very complex.   However, since you don't really need to know all this, we'll list some parts of that info that will help in deciding how to fill out the campaign info.   We have a doc with a list of Best Practices for a successful messaging campaign. Note that this doc has a lot of detailed information, so the sections that might be relevant for your business are Section 6 and Section 8. There is some useful notes in here about how to not run afoul of the mobile carriers rules around content, which is where much of the focus is. Messaging Best Practices   For officeXtend, the more common use-case will likely be "Low-volume mixed". When choosing this, select the types of content you might be sending, like "Customer Care" or perhaps "Marketing". Many of the other types are more common for automated systems (2FA, Account Notifications, etc) vs how you would send messages in officeXtend where you must type in your message one-by-one to each destination, though you can obviously choose to send the message to more than one number. Again, keep in mind the expected content of your messages will help determine the use case category to choose.   For "Campaign Content and Attributes", most of these will likely not apply to your manually entered messages except for "Embedded Link" and "Embedded Phone Number". If you commonly add a link or phone number to messages, Section 8.12.2 and Section 8.12.3 should be read and understood as these can easily trigger a review of your messaging campaign if you don't follow the recommendations.   The Campaign Description should be something about how you are using messaging, and some sample messages you might send are required to help TCR in evaluating your use-case and content.   And finally, the list of telephone numbers (TNs) that should be allowed to send/receive SMS/MMS messages as part of this campaign.   You can list up to 49 TNs for use with a campaign. Over 49 TNs incurs a very high fee in order for TCR and the mobile carriers to evaluate why you need more than that for a "campaign". When choosing these TNs, make sure the users of those TNs really do need to send messages externally. In many cases, users may only need to message within your organization and do not need to be listed as part of the campaign. This will help conserve the list of TNs so you can stay in that 49 TN range.     Where To Send the Form   Once you have the form filled out, you can email this to MessagingUseCase@inteliquent.com. Please include the following: Subject Line: SMS/MMS Brand/Campaign Form for UCaaS officeXtend Body: Include a brief description of what you are requesting and include additional contact info in your email request such as an authorized user on your account. Attachment: Don't forget to attach your filled-out form to the request and list the exact TNs that will be included in your campaign.   If you know your Customer Success representative, you can reach out to them to get the process started.   Fees The Campaign Registry (TCR) charges fees for their various services. The fees that we will be potentially passing through are the following:   Fee Cost Description Brand Registration and Vetting $10 One-time TCR Fee per Brand/Company Campaign Registration Fee $15 Fee per campaign   As an example, a typical brand and campaign registration would incur approx. $25 in fees. This would consist of the $10 TCR fee and the $15 fee per campaign. Typically only one campaign would be needed for use with officeXtend unless you have more than 49 numbers.   Penalties Watch your content. There are heavy penalties that will be passed on especially by T-Mobile for any content violations. Some examples include the following:   Penalty Fee Description 10DLC A2P Text Enablement Non Compliance Violation $10,000 T-Mobile penalty for sending texts from non-approved numbers - per violation 10DLC A2P Program Evasion Non Compliance Violation $1,000 T-Mobile violation for using evasive measures - per violation 10DLC A2P Content Non-Compliance Violation $10,000 T-Mobile penalty for content violations - per violation   If we are charged one of these fees due to a violation of your brand/campaign, we will pass these on to you. Repeated violations will result in your brand being blocked from future messaging campaigns.   Other operators may add penalties in the future. ... View more

Telecommunications Service Providers Must Meet Requirements before November 30, 2021 Deadline   Inteliquent’s goal is to assist and encourage our customers to comply with the Canadian STIR/SHAKEN requirements, so we’re sharing our company’s understanding of those obligations. The following summary is not intended as Inteliquent’s legal advice to you.  If you have questions, we recommend you contact your legal counsel or the Canadian Radio-television and Telecommunications Commission (CRTC) online at CRTC Support for Telecommunications Provider or call their Help Desk at 1.866.845.6063 or 819.997.4597.      What Obligations Do Providers Need to Meet to Comply with the CRTC Order?    The CRTC Order requires telecommunications service providers (TSPs) to implement the STIR/SHAKEN framework by November 30, 2021. The following criteria apply:  The STIR/SHAKEN implementation requirements apply to all IP-based voice calls (i.e., calls travelling over a TSP’s IP-based network, including any portion of the network enabled to initiate, transit, or terminate IP-based calls).   TSPs are required to file STIR/SHAKEN implementation readiness assessment by August 31, 2021 and to submit ongoing status reports by May 31, 2022 and every six months thereafter (at the end of May and November), providing details about any changes in network capability in relation to the information provided in the TSP’s implementation readiness assessment report.   The status reports due in May must cover from September 1 through February 28. And status reports due in November must cover March 1 through August 31.    The CRTC’s STIR/SHAKEN requirements apply to all Canadian carriers and other telecommunications service providers who provide voice telecommunications services in Canada. Consequently, if the company’s customers also provide voice services in Canada, the STIR/SHAKEN implementation and reporting requirements apply.     What Is the Status of Canada’s Service Provider Token Eligibility Policy?  Following a complaint from Mitel (a reseller) alleging providers lacking direct access to telephone numbers are unable to access required certificates for STIR/SHAKEN implementation, the CRTC announced on August 5 2021, its expectation for the Canadian Secure Token Governance Authority to develop, within 60 days, the eligibility requirements which “prevent access to STI certificates only for those TSPs who cannot be trusted to maintain the integrity of the STIR/SHAKEN framework” and “collaborate with non-eligible TSPs in the development of new eligibility criteria for access to STI certificates.”    As of August 10, 2021, the Canadian Secure Token Governance Authority has not updated the eligibility criteria, leaving TSPs without direct access to telephone numbers from the Canadian Numbering Administrator unable to implement STIR/SHAKEN in Canada at this time. However, given the CRTC’s order to the Governance Authority, we expect that changes to eligibility criteria will occur soon.    What Are the TSP Requirements for the Implementation Readiness Report Due by August 31, 2021?  Appendix 1 of the CRTC Order outlines the requirements for the implementation readiness report due by August 31, 2021. As explained further in the Telecom Commission letter, the STIR/SHAKEN implementation reports can be sent using the CRTC’s GCKey system (an online portal for document submission to the CRTC) or by email directly to Jean-Francois.Habour@crtc.gc.ca.     The Telecom Commission letter also provides a useful template for the report should you need it to provide readiness status on:  The percentage of STIR/SHAKEN-enabled trunks used for IP voice traffic versus total voice trunks . The percentage (by month) of authenticated/verified calls versus total number of voice calls. Statistics identifying tracking by level of authentication (e.g., STIR/SHAKEN attestation level) for calls delivered to customers .  The status and result of the company’s STIR/SHAKEN implementation readiness, including:  - Whether the authentication uses an analytic engine or whether the Verstat parameter is sent to the end-user - A brief description of the TSP’s IP voice network capacity to:           - perform complete intra-network STIR/SHAKEN-compliant calls          - authenticate and transmit the authentication information to the next TSP in the call path when originating a call         - receive and verify the caller ID information when terminating a call         - send the Verstat parameter to wireless and landline end-users when an analytic engine is not used.  transmit the STIR/SHAKEN information when transiting a call received on an IP interconnection from an upstream TSP and sent on an IP interconnection to a downstream TSP.  Authenticate unsigned calls received from an upstream TSP which either terminates on the TSP’s IP network or sent to a downstream TSP through an IP interconnection.  Handle diverted calls. Handle toll-free calls. Handle emergency calls. Handle legitimate spoofed calls .  A brief description of the status of IP interconnection with other TSPs (e.g. network-to-network interface and user-to-network interface interconnections). A brief description of the TSP’s authentication solution for enterprise clients. The status and results of equipment testing/participation in such tests. We Here to Help    Inteliquent’s provided our summary of the CRTC STIR/SHAKEN requirements to outline the TSPs obligations to assist you as you work towards meeting the November 30, 2021 STIR/SHAKEN deadline in Canada. Please note, our synopsis of the CRTC stipulations are as we understand them based on the guidelines we have to date and our interpretation may be inaccurate in certain respects, so please use it for informational purposes only. Additionally, this summary can’t be relied upon as legal advice or a recommendation for your company take, or not take regarding any action and we disclaim any liability.    The CRTC is expected to update the rules, and future updates may impact a TSP’s obligations. Inteliquent may provide our understanding of these updates as a courtesy to our customers, but we are under no obligation to do so. Once again, we recommend you contact your legal counsel or the Canadian Radio-television and Telecommunications Commission (CRTC) online at CRTC Support for Telecommunications Provider or call their Help Desk at 1.866.845.6063 or 819.997.4597 if you have questions about these guidelines.  ... View more

User Guide for your Inteliquent Enterprise SIP Trunking Portal   The Inteliquent Enterprise SIP Trunking portal features   The features of this portal make it easy for you to self-manage your telecom services. From the Inteliquent Enterprise SIP Trunking portal, you can: Buy new local numbers Buy new Toll Free numbers Ensure a default 911 address is available for each number Add CNAM to each number Enter your own orders to port in numbers you may already have that you would like to use with the service Create and manage new billing locations Move numbers between trunk groups or TF routes and billing locations Create accounts for other users in your company that you would like to help manage your services View call logs View your bills and Create support tickets with Sinch. Numbers you purchase can be added to any of your trunk groups and become immediately available for use, making our solution super easy for anyone looking to gain full control over day-to-day telecom operational needs.     Account Creation   When your account is ready to use, you'll receive an email inviting you to create your portal account. The link in the email will take you directly to the account sign-up page:     Once you are signed up, come back anytime to: https://portal.esip.inteliquent.com/ and login again to resume managing your services.   Dashboard   The Dashboard displays the count of local and toll free numbers that are on your account. NOTE: During the initial ordering processing, some numbers may already be on your account. You can review those and decide if you want to keep them or return them and buy new numbers:     You’ll use the navigation menu on the left to complete other activities, such as monitor usage, request new numbers, and manage your SIP trunking service.   Trunk Groups   Select Trunk Groups on the left navigation menu to view or manage existing trunk groups. There are two tabs: one for Trunk Groups (usually DID trunks) and one for Routing Labels for use with Toll Free numbers.   Trunk Groups Tab   You’ll initially see an overview of existing trunk groups, and each will have the pencil icon allowing you to make any necessary changes. The trunk groups are added to your portal during the onboarding process:     When you edit a trunk group, there are only a couple things you can change. The other fields are preset for you. The first option is adding a Customer Assigned Name to your trunk group. This is a name you add to make it easier to identify which trunk this is when assigning numbers or in other operations as you'll see later:     The other option above is to make this trunk group the Default. If you frequent add most of your numbers to this trunk group, this will be the default trunk when buying numbers so you don't have to choose the right one every time. This will be covered in the Buying Numbers section.   Routing Labels Tab   If you have or need Toll Free numbers, routing labels will be created for you during the onboarding process and entered here for you. Like with Trunk Groups, you have the same two options when editing a label:     Enter a Customer Assigned Name to provide your own name for the trunk groups, and decide which one should be the default when ordering toll free numbers:     Numbers and Locations   Selecting the Numbers and Locations option on the left navigation menu opens the dashboard for managing individual numbers and the locations of your offices or facilities. To view all numbers across all locations, select the main Numbers and Locations menu item. The view will show all numbers and include a Location column. If you select a specific location, only numbers in that location will show:     When you first log into your portal, you will likely only see one location, which would typically be the initial location the first order was placed for. Any numbers from the original order would be added to this location.   NOTE: Locations are a key distinction in that these are more than just a helpful designator for organizing your number inventory. They are also a billing element. On your monthly invoices, services will be broken down by the locations you have entered, including any taxes for the services based on those locations.   When you are in any of the locations (or the main one), there are three tabs for your Local Numbers (DIDs), Toll Free Numbers, and if you return a number, a tab to view and restore Local Numbers if you decide within 60 days that you would like that number back:       Adding a Location   Click Add Location on the left navigation menu, under the Numbers and Locations header. Fill in the address info in the Add Location dialog. Note that you need to separate out the Street Number from the Street Name. For any options like Room # or other options that are not part of the main street address, enter that in the Location section if needed. The Location field is generally more important when adding address information for E911 on a specific number rather than here which is primarily for main location and billing support. E911 addresses will be covered in another section on adding to numbers:     Next, click Validate. Any corrections will be made and shown prior to creating the location:     Click OK to accept the changes. The location dialog is updated with the suggested changes. You can further Edit the address or click Add to add this address to your list of locations.   Editing Existing Local Numbers   When viewing your list of local or toll free numbers, clicking the number allows you to edit various features and settings on the number.    Editing Local Numbers   The first option you can change is which Location the number is assigned to. Once changed, this will affect billing and taxation for the number and usage going forward. Any previous billing and taxation would be applied to the old location.   The next option lets you reassign which trunk group this number is assigned to. If you have multiple trunks groups and have a trunk down, or know you'll be doing maintenance but still want calls to route, you can reassign this number to another one of your working trunk groups:     The next section lets you add an E911 address for this number. Move the slider to Enable, then fill in the address fields. The Emergency Contact can be the company name or specific person this number is assigned to in your PBX. Use the Location field to enter more specific information such as a room number where the phone this number is assigned to is located:     Next, click Validate to determine if the address is valid or if there are corrections available:     Then click OK to apply any corrections to your address info. Next, click Update to add this E911 address entry to this number.   To change an existing entry on a number, move the slider to Disable. You will be prompted to click Disable again to remove this entry from the number. Once removed, move the slider to Enable again and enter the new address info.   Note that once an E911 address has been added to a number, additional required E911 taxes and charges will be applied based on the location the number has been assigned to.   The next section lets you set an Outbound Caller Name (CNAM) that would be seen by users when the user assigned this number places an outbound call. To set this, move the slider to Enable, enter the Outbound Caller Name (max 15 characters per PSTN standards) and click Update to apply. Move the slider to Disable to remove CNAM for this number. You can update the CNAM at any time, though CNAM updates can take several days to roll out to most carriers. The updates must be picked up by the terminating carriers, that is, the destination carrier serving the person you are calling. If the person you are calling is reporting no caller name or the wrong caller name, wait for several days to ensure the CNAM update has had sufficient time to be picked up:     The final two sections are optional and depend on if these have been enabled for you. The International Calling Features determines if the user assigned this number on your PBX can place calls to international numbers. The default is US destinations. If this option is available to you, and you want to allow international calling, move the slider to the Enable position.   The Call Forward feature allows you to forward calls to this number to a different 10-digit number. For example, if this is your main number and your PBX is down, you can forward the number to another destination until you can restore service. To enable this feature if it's enabled for you, move the slider to the Enable position. Click the arrow to expand the section and enter the 10-digit number you want to forward calls to. Click Update to apply the forward. To turn off call forwarding, move the slider to the Disable position.   At the bottom of this dialog box is another option - Return Number. If you no longer need this number, you can simply return it. The number will be removed from billing going forward. Returned numbers show in the Return/Restore Numbers tab. Local Numbers have the ability to be restored to service for up to 60 days. Click Restore to add this number back to your account:       Editing Toll Free Numbers   In your list of Toll Free numbers, click the number to edit it. The first option you can change is which Location the number is assigned to. Once changed, this will affect billing and taxation for the number and usage going forward. Any previous billing and taxation would be applied to the old location.   The next option lets you reassign which route label this number is assigned to. If you have multiple routes and one is down, or know you'll be doing maintenance but still want calls to route, you can reassign this number to another one of your working routes:     Just like for local numbers, you can add an E911 entry for a Toll Free number in case you have assigned one as the number sent out when user(s) call 911. See the section in Editing Local Numbers on how to apply E911.   The same thing applies to Outbound Caller Name. Adding one is the same as in the Editing Local Number section above:     For Toll Free numbers, you can add a DNIS string to replace the Toll Free number. Move the slider to the Enable position, enter the DNIS digits you would like to receive and click Update to add this service. To turn if off, move the slider to the Disable position.   The Call Forward feature is also available for Toll Free numbers and allows you to forward calls to this number to a different 10-digit number. For example, if this is your main number and your PBX is down, you can forward the number to another destination until you can restore service. To enable this feature if it's enabled for you, move the slider to the Enable position. Click the arrow to expand the section and enter the 10-digit number you want to forward calls to. Click Update to apply the forward. To turn off call forwarding, move the slider to the Disable position.   At the bottom of this dialog box is another option - Return Number. If you no longer need this number, you can simply return it. The number will be removed from billing going forward. Returned numbers show in the Return/Restore Numbers tab.   NOTE: Toll Free Numbers cannot be restored once returned.   Buying Numbers   To order new local numbers, choose the Numbers and Locations menu or click any Location, then click Add Number(s) in the upper right.   To order new Local Numbers, set the Number Type to Local. To order new Toll Free numbers, set the Number Type to Toll Free.   Extensive search options are provided to help you find the right numbers for your business:     Local Numbers   To order US numbers, set the Country to US (default). The State list will be updated to include the 50 states and the District of Columbia. If you need Canadian numbers, set the Country to Canada and the State list will be updated to include the Canadian Provinces.   Other options like Sequential let you retrieve a list of numbers that are numerically sequential by the last 4 digits. The Max Size defaults to looking for 10 sequential numbers. You can also search by Prefix or Rate Center.   The Vanity search option lets you enter a Phrase and a Position on where the phrase should match:       Toll Free Numbers   To order Toll Free Numbers, choose Toll Free as the Number Type. You can choose a Prefix to search, in addition to looking for sequential ranges or Vanity options as well:     Once you have a list of numbers that meet your search criteria, choose them from the list at the bottom by clicking the check box next to each number, then click on Buy Numbers. If you want to select all the numbers on the page, click the check box on the Number header bar.   Adding options to your number(s)   Once you choose Buy Numbers, you'll be provided an option to add a Location, Trunk Group (for Local Numbers), Route Label (for Toll Free numbers), E911 and Outbound Caller Name (CNAM) to the numbers. For Toll Free numbers, you can also add a DNIS string during the buying step.   The only mandatory options to choose when buying numbers is to select a Location for the services and to either choose a Trunk Group for Local Numbers (note the Default trunk group is automatically chosen) or a Route Label for Toll Free numbers (note the Default route label is automatically chosen).   You can add or change the E911, CNAM or DNIS for any number by going to by following the steps in Editing Existing Numbers above.   Order Details   The Order Details menu has two sub-options that allow you to create Port-In Orders and view completed Orders.   Port-In Orders   We'd love for you to adopt our service, so of course we've made number porting easy for you to do and fully under your control. Ordering and testing a few numbers on your account lets you determine how well the service will work for you and your employees. When are you ready to move your existing numbers over, click on the Port-In-Orders menu to begin.   If you've had any previous port-in orders, they will be listed here including any complete or pending orders. Click the order number to open any existing port order.   Creating a Port-In Order   Initially this page will not contain any existing port-in orders. To start a new port-in order, click the Create Order button:     Creating an order is done in a few steps. The first step is to make sure the numbers you want to move to our services are portable, that is, the numbers can be reassigned from your current carrier to us.   On the first screen, enter the numbers that you wish to port. You have several ways to enter the numbers depending on how many. If you have a few, you can just type in the 10-digit numbers in the +Add TN box on the right.   If you have them in a list such as in a column in Excel, you can select the entries and copy/paste those into the +Add TN box. The numbers should be 10-digit numbers without any 1- or +1- in front.   Optionally, you can click "here" in Download Sample CSV here at the bottom of the left-side box. This will download a CSV template that you can then add in your numbers, then import. Once you have your numbers entered, click Validate TN in the bottom right:     The port-in availability status will be shown in the next section. If your number(s) is portable, the Is Portable column will be Yes. If not, No will be shown and a reason for why the number is not portable will be shown. You can only port numbers to our service that indicate Yes:     Click Port-In TNs to go to the next section. At the top, the list of numbers that are portable will be shown. The remainder of the entries are critical to getting your port order entered correctly and making sure the porting process is smooth.   The information you are about to fill in provides us a Letter of Authorization, or LOA that allows us to submit a request to your current carrier to port your numbers. All information in this section must exactly match the information that your current carrier has. The best option is to get your current Bill Copy from your current carrier as this should have your current Account Number/Billing Telephone Number, correct Address and other information.   The first thing to do is decide on when you want the number port to take place. For business numbers, this can take up to two weeks or longer for complex ports.   Select a FOC Time Zone, and then choose a FOC Date and Time. FOC stands for Firm Order Commitment. This is the date and time you are requesting the port to take place. Your current carrier will need to accept this request and has up to 72 hours to do so. If your current carrier accepts your requested date and time, your numbers will port then.   Optionally, you can select the On Demand check box. You must then select a FOC Time Zone and FOC Date. The On Demand option lets you trigger the number port operation any time during the agreed upon FOC day:     The next section can be filled out using your current bill copy. The information on the left must match your current carrier information. Any field with a * is required to be entered. Once you have entered the information, select the numbers in the column on the right, then click the right-facing arrow to move those over to the next column:     Scroll further down and you will see an area to Upload a Letter of Authorization. This is not required unless you know the carrier you are porting from requires one. If so, contact your sales rep for the latest LOA from. Fill that out, get it signed, and upload a PDF copy of the signed form here. You can also upload a Bill Copy if the other carrier asks or requires it. Then click Next at the bottom-right to go to the order review page.   Review your port-in order to make sure the information looks correct and then submit the order.   Once your order is submitted, it will now show in your list of Port-In Orders.     Creating a Toll Free Port-In Order   To port in a Toll Free number, click the Toll Free Numbers tab, then enter the number(s) you wish to port in. Click on Port-In TFs at the bottom right:     Toll Free numbers ports always require an LOA form. You must fill it out and add it to the port order:     Then click Next to continue.    Review your TF port-in order to make sure the information looks correct and then submit the order.   Once your order is submitted, it will now show in your list of Port-In Orders:   Reviewing Port-In Orders   To check the status of your port-in order at any time, click the Port-In Orders menu. The Status indicates what state your port order is in. Pending means the order has not completed yet. Closed means the order is completed. Cancelled means the order has been cancelled and will no longer port. For Pending orders, the details in the other columns indicate the progression of the order. If all your numbers have a FOC confirmation, then the FOCED column quantity will match the TN Quantity column and the FOC Date(s) column will list what date/time your current carrier has accepted. This will typically be what you requested.   If your carrier has rejected your request, the number quantity will be listed in the Rejected column. To see why the port request was rejected, click the Notes icon on the far right to review any order notes. To fix up any information, click the Order ID, then click Update to make changes and resubmit.   When the port has completed, the numbers will be shown as Activated and the order status will move to Closed.   In the example below, the first order in the list is a TF port order. These orders do not have the activation or other statuses to view. The second oder is a DID order:     NOTE: When your numbers complete the porting request, they will be added to your number inventory and assigned to the Trunk Group or Route Label you designated as the Default. Go to the section on Editing Existing Numbers to see how to change the trunk group, add E911, add Calling Name or other options you can set on these numbers.   Orders   Orders is the second option under the Order Details heading and displays all completed orders related to your SIP trunking services. Click anywhere on a row to expand the order and view the order information.   Bulk Update   You may need to change a large amount of numbers at once. Making these changes individually can quickly become time-consuming and error-prone, so we’ve developed a Bulk Update option for processing bulk changes.   Bulk Update   Look for the Bulk Update option under the Bulk Update menu heading:     The process begins by selecting Download CSV and entering your email address; it will use the account email by default, but this can be changed.   You’ll receive an email with a CSV document with your organization's numbers and settings. The CSV file will contain many of the options you see when you individually edit a number.   The first columns are for reference: DID (this applies to TF as well) RATECENTER (not applicable to Toll Free so this will be blank) STATE (not applicable to Toll Free so this will be blank) DID_TYPE (either TF or LC). Do not change these values since these are used to identify exactly which number you are changing.   The next columns are in groups and let you change the following: Outbound Calling Name OUTBOUND_CALLER_NAME_ENABLED - Y/N OUTBOUND_CALLER_NAME_ENABLED (enter the up to 15 character name you want for the outbound caller name (CNAM) E911 E911_ENABLED (Y/N) E911_EMERGENCY_CONTACT E911_STREET_NUM E911_STREET_NAME E911_CITY E911_STATE E911_EMERGENCY_RESPONSIVE_LOCATION E911_ZIP_CODE INT_CALLING_ENABLED (used to enable inbound for a number if allowed - Y/N LOCATION - (Billing Location Name) TRUNK_GROUP (Trunk group name if a Local Number (DID) - blank otherwise) ROUTE_LABEL (Route label name if a TF number - blank otherwise) Note that when you download this file, it will contain all of your current numbers. If you only want to apply changes to certain numbers, delete the rows for all the numbers you don't want to change and only import the rows of numbers you do want to change.   Once done, return to the dashboard and select Upload and Validate. After validation has been completed, you will then click Update to process all requested changes.   History   You can view all previous bulk updates by selecting History under the Bulk Update menu heading.   Account   The Account menu heading contains several options to manage users, monitor usage, view bills, and create support tickets.   User   The User menu allows you to create additional users at your company that you may want to help manage your account. Select Users under the Account menu heading to view all active users. To add users, click Add New User in the upper right:     Click + Add New User to invite a new user to view the dashboard. Check the Admin Access box if they will require administrative access to help managed the account; otherwise, leave it unchecked to provide read-only access. Select Send Invitation once complete.     Selecting an existing user will provide a similar pop-up to allow you to modify the user’s email address, name, or change admin access rights. Modifying an existing user also includes a Deactivate User option.     Call Logs   All calls made through our SIP trunking services are logged. You can view completed calls by selecting Call Logs under the Account menu heading. Select the calendar to create a custom date range and click Apply. You can also input From Number and/or To Number to view calls specific to those numbers. Finally, click Search to have results displayed on the page, or select Download CSV to receive a CSV file with the requested data:     ... View more