Make a call

You can make an outbound call through our Voice API by sending a HTTP POST request to our RESTFul call resource.

That's right, it is now actually possible to curl someone... See what we did there :)


How To Make an Outgoing Call

Here is how it all comes together...

1. Your application invokes our REST resource for making calls. You can use the call() function in our helper gateway classes to do this (see below)

2. Our API calls the user(s) specified in the request

3. The user answers the call

4. Our API sends a POST request to the URL that you have set for that phone number in your Voice Dashboard. The parameters passed in with this request are outlined in the section on handling calls

5. Your application responds with XML that tells our API how to handle the call. This XML will typically contain a list of actions that our API will execute in sequence.

6. Our API translates those actions into events or messages relayed back to the caller

You need your AfricasTalking username and APIKey for any request to our API. If you don't have an APIKey, please click here to get one.

The CSharp code snippet below shows how to make a call using our API.

The code uses our CSharp gateway class: AfricasTalkingGateway.cs [ Download]

We use the Javascript serializer to encode and decode data so be sure to add System.Web.Extensions and System.Microsoft.CSharp as your referenced libraries in you project.

using System;

class MainClass
{
	
	static public void testCalling ()
	{
		// Specify your login credentials
		string username = "MyAfricasTalking_Username";
		string apiKey   = "MyAfricasTalking_APIKey"; 
		
		// Specify your Africa's Talking phone number in international format
		// Please ensure you include the country code (+254 for Kenya in this case)
		string from = "+254711082XXX";
		
		// Specify the numbers that you want to call to in a comma-separated list
		string to = "+254711XXXYYY,+254733YYYZZZ";

		// Create a new instance of our awesome gateway class
		AfricasTalkingGateway gateway = new AfricasTalkingGateway (username, apiKey);

		// Any gateway error will be captured by our custom Exception class below,
		// so wrap the call in a try-catch block          
		try {

			dynamic results = gateway.call(from, to);

			foreach (dynamic result in results) {
				// Only status "Queued" means the call was successfully placed
				Console.Write((string)result["status"] + ",");
				Console.WriteLine((string)result["phoneNumber"]);

			}
			Console.WriteLine ("Calls have been initiated. Time for song and dance!");
			
			// Our API will now contact your callback URL once the recipient answers the call!   

		} catch (AfricasTalkingGatewayException e) {

			Console.WriteLine ("Encountered an error: " + e.Message);		

		}
	}
}
Our REST resource for making calls is located at: https://voice.africastalking.com/call. In order to make a call, you will need to pass in the following parameters within a POST request:
Variable Name Location Description
apikey Header Your API Key, which you can generate from your dashboard
username Body Your Africa's Talking account username
from Body Your Africa's Talking phone number (in international format)
to Body The phone number that you wish to dial (in international format)

You can check the HTTP Response Code to determine whether the request was successful. Any response code other than 201 (Created) indicates that the call was not initiated

Example using CURL client
curl -H "Accept: application/xml" -H "Apikey:fb752d3417021812f0961y6c9464832dd1adb1e555c73f1e7c32bcc006488674" -d "username=myUsername&to=+254711XXXYYY&from=+254711082XXX" https://voice.africastalking.com/call