Number of queued calls

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 Python code snippet below shows how you can get number of queued calls of your Africas Talking phone number using our API.

The code uses our Python gateway class: AfricasTalkingGateway.py [ Download]

# Be sure to import helper gateway class
from AfricasTalkingGateway import AfricasTalkingGateway, AfricasTalkingGatewayException

# Specify your login credentials
username = "MyAfricasTalking_Username"
apikey   = "MyAfricasTalking_APIKey"

# Specify your Africa's Talking phone number in international format 
#Comma separate them if they are more than one
phoneNumber = "+254711082XXX"

# Create a new instance of our awesome gateway class
gateway  = AfricasTalkingGateway(username, apikey)

#*************************************************************************************
#  NOTE: If connecting to the sandbox:
#
#  1. Use "sandbox" as the username
#  2. Use the apiKey generated from your sandbox application
#     https://account.africastalking.com/apps/sandbox/settings/key
#  3. Add the "sandbox" flag to the constructor
#
#  gateway = AfricasTalkingGateway(username, apiKey, "sandbox");
#**************************************************************************************

# Wrap the call in a try-catch block
# Any gateway errors will be captured by our custom Exception class below, 
try:
	# Get queued calls
	queuedcalls = gateway.getNumQueuedCalls(phoneNumber)
    
    # For a specific queue, specify the queue name eg:
    # queueName = "myQueueName"
    #results = gateway.getNumQueuedCalls(phoneNumber, queueName)
	
	for result in queuedCalls:
		print "phoneNumber: %s; queueName: %s; number of queued calls: %s \n" % (
		                                                          result['phoneNumber'],
		                                                          result['queueName'],
		                                                          result['numCalls']
		                                                         )
except AfricasTalkingGatewayException, e:
	print 'Encountered an error while making the call: %s' % str(e)

Our REST resource for getting the number of queued calls is located at: https://voice.africastalking.com/queueStatus. In order to get the number of queued calls, 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
phoneNumbers Body Your AfricasTalking phone number mapped to your account

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&phoneNumbers=+254711082XXX" https://voice.africastalking.com/queueStatus