# Introduction An intro to Sendchamp Guide 👏 [Sendchamp](https://www.sendchamp.com/?utm_source=product_guide\&utm_medium=gitbook-io\&utm_campaign=api_reference_gitbook) is a multi-channel communication platform for businesses and developers in Africa. With Sendchamp, you can seamlessly send messages to customers/users across SMS, WhatsApp, Email and Voice and other messaging channels using our APIs and a super simple but powerful dashboard. We are helping businesses send & receive messages, verify customer and retain customers through multiple messaging channels. This guide is a work in progress. It helps to explain some of Sendchamp’s concepts in clear terms. ## Helpful Links **API Reference is** [here](https://sendchamp.readme.io/) **Sendchamp Dashboard is** [here](https://my.sendchamp.com/?utm_source=product_guide\&utm_medium=gitbook-io\&utm_campaign=api_reference_gitbook) **Our Marketing Dashboard** to send marketing campaigns and support your customers across channels is [here](https://dash.bodsquare.com/?utm_source=product_guide\&utm_medium=gitbook-io\&utm_campaign=api_reference_gitbook) **Postman Collection**\ For quicker test, you can import our postman collection [here](https://www.getpostman.com/collections/263a6ef74ae1cf4131ef) and test available APIs on Postman **Support & Developer Community** If there is something you are not clear about or can’t find, please send an email to . or drop a message on our community platform on [Slack](https://community.sendchamp.com) # Authentication [Sendchamp](https://www.sendchamp.com/privacy?utm_source=product_guide\&utm_medium=gitbook-io\&utm_campaign=api_reference_gitbook) uses API keys to authenticate requests.. Your API keys carry many privileges, so be sure to keep them secure! Do not share your API keys in publicly accessible areas such as GitHub, client-side code, and so forth. We provide you with an Access key on your dashboard as you sign up to enable you to authorize API requests. You can find your Access key in the Account Settings > API & Webhooks section. ![](/files/uae1E0xadEKL7CyZ9HyI) # Voice # Overview Sendchamp Voice Messaging allows you to transform text messages into voice messages to any country. You can send messages using our Voice API or from your dashboard. # Send a Voice Message It is quite easy to send voice messages to your customers from your dashboard. Quick demo requires only the recipient phone number and the message to be transformed into voice message. To send a voice message, 1. Input recipient phone number 2. Input the message to be transformed into your voice message. ![](/files/MHtVdeceInVSwMMLmUKM) You will be asked to preview your message and your recipient phone number unlike the quick demo. ## # Voice Report You can easily track and view the report of your voice messages. Voice reports can be filtered using date and a phone number. When you filter using date, a report will be displayed between the dates. The dashboard of the Voice report will show you the total number of messages sent, started, answered, completed, ringing and and failed. ![](/files/7YjXCTC8w12CCo8dzfag) # SMS # Overview Sendchamp allows you to send SMS messages to any country in the world through our SMS API and directly from your dashboard. # Create a Sender ID You can create your Sender ID in SMS Overview > Create Sender ID ![](/files/f2YkHk4Xnm2G44hiirmT) Click on Add Sender ID. This will prompt a modal that explains everything about creating a Sender ID and how it works. Click on continue and create your sender ID. To add a sender ID, you have to choose a unique name for it. You will also be required to select your use case for the sender ID. To finalize creating your sender ID, you will be required to type out a sample message. To be able to make use of your new Sender ID, it has to be approved from our end and it takes usually less than a day to be activated across all telcos in your country but you can register our default Sender ID to kickstart. Once your sender ID has been activated, you can make use of it without restrictions. # Quick Demo Quick demo allows you to send messages swiftly to a single phone number. It requires you select a Sender ID from your list of IDs, input the recipient phone number and your message. ![](/files/0EF8iZo9DuTjtIff2fgV) # SMS Report You can easily track and view the report of your messages. SMS reports can be filtered using date and a phone number. When you filter using date, a report will be displayed between the dates. The dashboard of the SMS report will show you the total number of messages sent, processing, delivered and failed. ![](/files/tiZlUbObDdaL8tiYxDlg) # WhatsApp # Overview Sendchamp WhatsApp Business API allows you to send and receive WhatsApp messages for alerts, notifications, customer support, as well as verification OTPs. # Activate WhatsApp Number To activate your WhatsApp number, visit WhatsApp dashboard on your Sendchamp dashboard, click [here](https://my.sendchamp.com/channels/whatsapp) for easy redirection and click on activate number Choose a subscription plan that is suitable for you. You won’t be asked to pay for it until your number is active. When you select a plan, you’ll be redirected to a page that would ask you to fill in the necessary information. Basic information, WhatsApp account information and your business information. ![](/files/wvKEaECVbgobqJJKe7UQ) # Send a WhatsApp Message You can send WhatsApp message from the dashboard. This allows you to test WhatsApp before implementing the WhatsApp Business API. ![](/files/aAMM1c5iCiM9FLWMOkfk) # WhatsApp Template Go to the WhatsApp channel and click on overview and navigate to [Create WhatsApp Templates](https://my.sendchamp.com/channels/whatsapp/viewTemplates). ![](/files/fT9Kq6LgSE3sZuJrIL6V) A preview of what a Message Template looks like. Choose your category, name, and language. * Category: Choose which type of template you'd like to create. You can hover over the template types to view details for each template. * Name: Enter name of the template. * Language: Choose the language your message template will include. ![](/files/elGcYFdZxUitfMmJaal9) Add your content in additional settings. add a sample template by clicking the Add Sample button. This helps Sendchamp during the review and approval process. You can edit text formats, add emojis, or include variables, which allow a developer to add unique information such as specific names, locations, or tracking numbers when inputting the templates into the API. The variables are shown in the above example as {{1}} {{2}} and {{3}}. When completed, click Submit. Your template will now be sent for review. The status of your template is viewable under Message Templates. # Facebook Business ID Guide to getting your Facebook business ID to setup Whatsapp on Sendchamp Activating a WhatsApp number with a Facebook Business ID allows you to set up your default display name so that your customers can have clue that the message came from you. WhatsApp display name is similar to a Sender ID in the case of SMS and Verification. To access your business ID, navigate to [Facebook Business Dashboard](https://business.facebook.com). If you don't have a business account, create one. ![](/files/dqnwQznD9FSjePb2xMKk) Facebook allows businesses to create multiple business accounts. ![](/files/xsJLxn2cpnqG8gf3Mme8) The above account has only one business account. Click on settings and access the account information, there you will find your Facebook Business Manager ID. ![](/files/IrKZeBFK3VQ10DMXpxol) # WhatsApp Report You can easily track and view the report of your WhatsApp messages. WhatsApp reports can be filtered using date and a phone number. When you filter using date, a report will be displayed between the dates. The WhatsApp report dashboard will show you recipient phone numbers, date the messages were created and the status of the messages. ![](/files/55KfApoCyRNaj2H240jB) # Verification # Overview Sendchamp allows you to verify your customers via multiple channels. You can verify your customers through SMS, Email, WhatsApp and Voice. You can send your first OTP and a quick demo from your dashboard or you can use our Verification API. # Sending an OTP You can send an OTP from your dashboard or using our Verification API. To send an OTP, you are required to specify some attributes such as; 1. Channel: Voice, SMS, WhatsApp or Email 2. Sender: Your Sender ID, check [here](broken://pages/pPbKN6W91ki3TttMTKtV) for more details. 3. Token length: The length of the token you want to send to your customer. Minimum is 4. 4. Token type: numeric or alphanumeric 5. Expiration time: How long do you want it to be active for in minutes. (E.g 10 means 10 minutes ) 6. Customer Email Address: The email address of your customer. It's required if you're using Email Channel 7. Customer Mobile Number: The phone number of your customer. It must be in international format (E.g 2348012345678). It is required if you're using the SMS or Voice Channel ![](/files/lh5I4omQLmWDm6Pc2GxU) # Confirming an OTP Currently, you can only confirm an OTP using the verification confirmation API by specifying the verification reference and the verifcation code. # Verification Pop Up With little code, you can get access to a beautifully designed User Interface that helps you Send OTP, and Verify OTP via different messaging channels. Watch Our Demo Below ## Demo ![Demo](/files/deK2InztCe0ZJNsvki29) ## Code Sample (Redirect/Pop Up) # Verification Report You can easily track and view the report of your Verification messages. Verification reports can be filtered using date and a phone number. When you filter using date, a report will be displayed between the dates. The verification report dashboard will show you the recipient phone numbers, date the messages were created and the status of the messages. ![](/files/cMYZgbnAojyOBJo9Xi2h) # Overview An overview of how our wallet works on Sendchamp Your wallet gives you privileges to use any of our services without restriction. Whether you are sending a message from your dashboard or using an API. Users are charged from their wallet for each transaction. You can fund your wallet as quickly as possible. # Funding Your Wallet Funding wallet on Sendchamp guide You can easily fund your wallet by clicking the top up button on your dashboard. When you add an amount and click on top up, you will be redirected to a payment merchant to fund your wallet. ![](/files/o5xFiVF83seiXQ1AInt3) You can pay in any currency of your choice, We support mostly NGN, USD, EUR, GBP, Ksh and other African currencies. # Checking Balance Your wallet balance is displayed on your dashboard. You can retrieve your total balance and balance information from your account, such as currency and type of payment. You can use our Wallet Balance API to expose this information in one of your app or internal dashboards, as well as to send notifications. # Our Developer Community Join Sendchamp developer community Our community is on [Slack](https://community.sendchamp.com) with over 1k developers. Join us [here](https://community.sendchamp.com/) # Postman Collection Sendchamp Postman collection Our postman collection contains all our available APIs. This collection makes it easy for users to integrate any of our services by exploring the endpoints and request payloads. Here is a link to our [collection](https://www.getpostman.com/collections/263a6ef74ae1cf4131ef). # SDKs/ Libraries Our SDKs and libraries makes it easy for users to integrate our APIs using their favourite languages. Below is a list of available SDK/libraries JavaScript Libraries [JavaScript SDK](https://github.com/fuadop/sendchamp-sdk) by [Fuad Olatunji](https://github.com/fuadop) [Sendchamp](https://github.com/seunsanyaa/sendchamp) by [Seun Sanyaa](https://github.com/seunsanyaa) PHP Libraries [Laravel sendchamp](https://github.com/Mujhtech/laravel-sendchamp) by [Mujeed Muhideen](https://github.com/Mujhtech) Go lang [Golang Library](https://github.com/fuadop/sendchamp) by [Fuad Olatunji](https://github.com/fuadop) Python [Python Library](https://github.com/keosariel/sendchamp-py) by [Kenneth Israel](https://github.com/keosariel) We are building more libraries and Sdks for different languages. Feel free to reach out to us if you are interested in helping the community build an SDK or library. You can explore more by visting our [developer hub](https://developers.sendchamp.com/privacy?utm_source=product_guide\&utm_medium=gitbook-io\&utm_campaign=api_reference_gitbook). # Plugins We currently don't have any plugins at the moment. If you wish to build one for us, please reach out us through our helpdesk or our community group.