SUMMARY.md

Summary

Overview

• About
• Account Credentials
• Postman Collection
• Messaging API Concepts
• v1 → v2 Migration Guide

Initial Account Setup

• via UI
  • 1. Get your account ID
  • 2. Setup your Application
  • 3. Create subaccount (site)
  • 4. Create location (sippeer) and assign the application
  • 5. Order Phone numbers to location (sippeer)
  • 6. Sending Messages
• via API
  • 1. Create application
  • 2. Create location (sippeer)
  • 3. Enable SMS on Location (sippeer)
  • 4. Enable MMS on Location (sippeer)
  • 5. Assign Application to Location (sippeer)
  • 6. Order Available Numbers
  • 7. Check Order Status
  • 8. Send Text Message
• Video walkthrough

Phone Number Management

• Ordering Phone Numbers Overview
• GET Search For Phone Numbers
• POST Order Phone Numbers
• GET Fetch Order Info
• POST Disconnect a Phone Number
• GET Fetch Disconnect Info

Application API & Setup

• Applications Overview
• POST Create Application
• GET List Applications
• GET Fetch Application info
• PATCH Partial Update Application
• PUT Completely Update Application
• DELETE Remove Application
• GET List Associated Sippeers

Messaging API

• Messages Overview
• POST Send Message
• POST Send Group Message

Message Callbacks

• About Message Events/Callbacks
• Incoming SMS/MMS Message
• Incoming Group Message
• Message Delivered
• Message Failed

Error Codes & Responses

• Message Error Codes
  • Message Error Reporting
  • Error Code Schema
  • Error Code Table
    • Bandwidth Detected Client Errors
    • Carrier Reported Client Errors
    • Bandwidth Service Failures
    • Carrier Reported Service Failures
    • Carrier Errors with Ambiguous Cause
• 400 - Bad Request
• 401 - Unauthorized
• 403 - Forbidden
• 415 - Unsupported Content Type
• 429 - Too Many Requests

SDKs

• NodeJS
• C#
• Ruby