Messaging 2.0 Account Setup (UI)

This walks through the steps to configure your Bandwidth Phone Number Dashboard and Messaging API to work together. This guide is entirely focused on setup with the UI. If you'd like to follow along with the API, head to the via API to follow along there.

Assumptions

Follow along with Postman

Fill out the form on the Postman page to download the Messaging 2.0 collection.

Steps

  1. Get your account ID
  2. Create your first Application
  3. Create subaccount (site)
  4. Create location (sippeer) and assign the application
  5. Order Phone numbers to location (sippeer)
  6. Sending Messages

Get your account ID

  1. Log into the Bandwidth Phone Number Dashboard
  2. Click the Account tab in the menu section to go to your Account Overview
  3. Under the Account overview section you should see your account ID.

Get Account Id

Create your first Application

ℹ️ Learn more about Applications ℹ️

The Application contains the HTTP URL you want to use for both inbound and outbound messages.

Application Parameters

Parameters Mandatory Description
AppName Yes Plain text name of the application
CallbackUrl Yes Url to receive all message events
CallBackCreds No Basic auth credentials to apply to your message events
CallBackCreds.UserId No Basic auth UserId
CallBackCreds.Password No Basic auth Password

Create Application

POST https://dashboard.bandwidth.com/api/accounts/{{accountId}}/applications HTTP/1.1
Content-Type: application/xml; charset=utf-8
Authorization: {user:password}

<Application>
    <AppName>Production Server</AppName>
    <CallbackUrl>https://yourSecureSite.com/callbacks</CallbackUrl>
    <CallbackCreds>
      <UserId>Your-User-id</UserId>
      <Password>Your-Password</Password>
  </CallbackCreds>
</Application>

Response

HTTP/1.1 201 Created
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ApplicationProvisioningResponse>
    <Application>
        <ApplicationId>d775585a-ed5b-4a49-8b96-f68c0a993ebe</ApplicationId>
        <ServiceType>Messaging-V2</ServiceType>
        <AppName>Production Server</AppName>
        <CallbackUrl>https://yourSecureSite.com/callbacks</CallbackUrl>
        <CallbackCreds>
            <UserId>Your-User-id</UserId>
            <Password>Your-Password</Password>
        </CallbackCreds>
    </Application>
</ApplicationProvisioningResponse>

Create sub-account (site)

  1. Navigate to the Add a sub-account page (if you already have a sub-account you'd like to use, you can skip this step)

    • Account > Configuration > Sub-accounts > Add a sub-account
  2. You'll need a sub-account (site) in order to create a location (sippeer).

  3. Fill in the address and set the type to Service

Create Sub-account


Create location (sippeer) and assign the application

  1. Navigate to the Add a location page

    • Account > Configuration > Locations > Add a location
  2. You'll need a location (sippeer) in order to group phone numbers.

  3. When creating the location be sure to check:
    • SMS Enabled
    • Toll Free (if available)
    • Short Code (if available)
    • V2 Messaging
    • Application - Select the application created above
  4. If you need Toll Free or Short Code support contact support to enable.

More Detail

detail Location


Order Phone numbers to location (sippeer)

  1. Navigate to the Order New Numbers page

    • Orders > Order New Numbers
  2. Once your application, sub-account (site), and location (sippeer) have been configured you're ready to start ordering phone numbers to use.

  3. Using the UI, search for a number and order it to the sub-account (site) and location (sippeer) created above.

Order numbers


Sending Messages

ℹ️ Learn more about Messages ℹ️

  • To send a message, POST to the /messages endpoint
  • In the V2 Messaging API, messages are sent asynchronously. Message validation will happen after the server returns HTTP 202 - Created. API clients should listen for HTTP callback events to track message state after the initial POST request.

Message Parameters

Parameter Mandatory Description
from Yes One of your telephone numbers the message should come from (must be in E.164 format, like +19195551212).
to Yes The phone number the message should be sent to (must be in E.164 format, like +19195551212).
text Yes The contents of the text message (must be 2048 characters or less).
applicationId Yes The ID of the Application your from number is associated with in the Bandwidth Phone Number Dashboard.

Send Text Message

POST https://api.catapult.inetwork.com/v2/users/{{userId}}/messages HTTP/1.1
Content-Type: application/json; charset=utf-8
Authorization: {token:secret}

{
  "from"          : "{{your-bandwidth-number}}",
  "to"            : "{{yourTN}}",
  "text"          : "Good morning, this is a test message",
  "applicationId" : "{{your-application-id}}"
}

Response

HTTP/1.1 202
Content-Type: "application/json;charset=UTF-8"

{
    "id"            : "15047516192013g5tuga77zsa6jrp",
    "owner"         : "+19193529968",
    "applicationId" : "05851417-c78b-4636-81a2-014a54d8f119",
    "time"          : "2017-09-07T02:33:39.201Z",
    "direction"     : "out",
    "to"            : ["+19191231234"],
    "from"          : "+19193524444",
    "text"          : "Hi from Bandwidth!"
}

results matching ""

    No results matching ""