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 Ruby 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 Ruby and Rails gateway class: AfricasTalkingGateway.rb [ Download]

# Include the helper gateway class
require './AfricasTalkingGateway'

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

# Specify your AfricasTalking phone number in the international format(Comma separate them if many)
phoneNumber = "+254711082XXX"

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

# Any gateway errors will be captured by our custom Exception class below,
# so wrap the call in a try-catch block
begin
  results = gateway.getNumQueuedCalls(phoneNumber)
  
  # For a specific queue, specify the queue name eg:
  # queueName = "myQueueName"
  #results = gateway.getNumQueuedCalls(phoneNumber, queueName)
  
  results.each{|res|
  	puts "Phone number: " + res.phoneNumber + "; Queue name: " + res.queueName + "; Number of queued calls: " + res.numCalls + "\n";
  }

rescue AfricasTalkingGatewayException => ex
  puts 'Encountered an error: ' + ex.message
end

# DONE!

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