Skip to content

Instantly share code, notes, and snippets.

@kellyjandrews
Last active February 26, 2019 19:09
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save kellyjandrews/77c45cb4f0d468a99dd1ad8d96a6edd3 to your computer and use it in GitHub Desktop.
Save kellyjandrews/77c45cb4f0d468a99dd1ad8d96a6edd3 to your computer and use it in GitHub Desktop.
Nexmo Readme Boilerplate

Create a Voice Application

This application requires a Nexmo application and phone numbers. To create the application, use the nexmo app:create command with the Nexmo CLI.

The parameters are:

  • <<APP NAME>> - the name of the voice application
  • <<FILENAME>> - the name of the private key file, in this instance <<FILENAME>> is expected
  • <<ANSWER WEBHOOK>> - the webhook called the Nexmo number receives an inbound call
  • <<EVENT WEBHOOK>> - the webhook called when the call status changes
nexmo app:create --keyfile <<FILENAME>> <<APP NAME>> <<ANSWER WEBHOOK>> <<EVENT WEBHOOK>>

Once completed, this command will return a UUID (Universally Unique Identifier) that identifies your application. Copy and save the UUID for use in an upcoming step.

Link Phone Numbers

You will need to use a phone number already associated with your account, or purchase a new one.

List Phone Numbers

Use this command to list purchased phone numbers associated with your account.

nexmo numbers:list

Purchase Phone Numbers

nexmo number:buy --country_code US --confirm

Licenses

  • The code samples in this repo are under MIT

  • The tutorials contents are under Creative Commons, CC-BY-SA 4.0

The MIT License (MIT)
Copyright (c) 2018 Nexmo Community
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment