GroupCall allows you to initiate an outbound call to multiple locations through one request. The call can be to any devices or endpoints that FreeSWITCH supports like SIP phone, Regular Phone or even GTalk. The first endpoint answering is bridged and others are dropped.
If ConfirmSound and ConfirmKey are set, endpoint must press a digit to accept the call. When confirmation is done, all others endpoints are dropped.

GroupCall Request URL

To make a group call, make an HTTP POST to the below URL with the required parameters:

http://{BASEURL}/{ApiVersion}/GroupCall/

POST Parameters

Required Parameters

You must POST the following parameters:

Parameter Description
Delimiter Any special character (with the exception of ‘/’ and ‘,’) which will be used as a delimiter for the string of parameters below. E.g. ‘<
From The phone number to use as the caller id (with the country code). E.g. 15551234567
To The numbers to call (regular phone numbers must be prefixed with country code but without the ‘+’ sign) separated by the Delimiter E.g. 15557654321<15556543210
AnswerUrl The fully qualified URL that Plivo will request RESTXML from, each time a call connects. This will be used to control the connected call, as is the case for inbound calls. Parameters mentioned here would be sent along.
Gateways Gateways for a given number: This should be valid FreeSWITCH gateway strings separated by comma. If multiple gateways are specified, all the gateways will be tried sequentially for failover for the specified number of retries. E.g. 'user/,sofia/gateway/PSTN1/'.
Gateways between each number: These should be separated by delimiters. E.g. 'user/,sofia/gateway/PSTN1/<user/,sofia/gateway/PSTN2/'.
Optional Parameters

You may POST the following parameters:

Parameter Description
RejectCauses List of reject causes for each number (comma ‘,’ separated).
If attempt to call one number failed with a reject cause matching in this parameter,
there isn’t more call attempts for this number
(Default NO_ANSWER,ORIGINATOR_CANCEL,ALLOTTED_TIMEOUT,
NO_USER_RESPONSE,CALL_REJECTED
).
See freeswitch hangup causes doc for a list of available hangup causes.
CallerName List of caller name to use with the calls separated by Delimiter.
ConfirmSound Remote URL to fetch with POST HTTP request which must return a RESTXML with Play, Wait and/or Speak Elements only (all others are ignored). This RESTXML is played to the called party when he answered. (default none)
ConfirmKey A one key digits the called party must press to accept the call.
HangupUrl The URL that will be notified by Plivo when the call hangs up. HangupCause will be sent to the URL as a POST parameter along with other parameters.
RingUrl The URL that Plivo will notify when the call starts ringing. RequestUUID corresponding to the API request sent earlier and CallUUID will be sent along with the other parameters.
ExtraDialString E.g. "bridge_early_media=true,hangup_after_bridge=true" This will add these channel variables to the dialstring in FreeSWITCH while dialing a number. You can use any channel variables supported by FreeSWITCH for granular control. Please refer to this link for more details
GatewayCodecs GatewayCodecs for a given number: Through this parameter you can choose the valid codec(s) to be used for each FreeSWITCH gateway. E.g.'PCMA,PCMU','G729,PCMU'.
GatewayCodecs between each number: These should be separated by delimiters. E.g. 'PCMA,PCMU','G729,PCMU'<'PCMA,PCMU','PCMA,G729'
GatewayTimeouts GatewayTimeouts for a given number: As the name suggests, gatewayTimeouts indicates the timeouts (in seconds) for each FreeSWITCH gateway. E.g "10,10,10". Here Plivo will use 10 seconds timeouts while trying to dial a call through each of the three gateways.
GatewayTimeouts between each number: These should be separated by delimiters. E.g. "10,10,10<20,20,20". Here Plivo will use 10 seconds timeouts for the first call and 20 seconds timeouts for the second call.
GatewayRetries GatewayRetries for a given number: The number of times each of the gateways must be tried. E.g. "2,1,1" Here gateway 1 will be tried twice and others gateways will be tried once each.
GatewayRetries between each number: These should be separated by delimiters. E.g. "2,1,1<3,3,3" For the first call, gateway 1 will be tried twice and others gateways will be tried once each. For the second call, each gateway will be tried thrice.
SendDigits The SendDigits parameter tells Plivo to play DTMF tones when the call is answered. This is useful when dialing a phone number and an extension. Plivo will dial the number, and when the automated system picks up, send the DTMF tones to connect to the extension. SendDigits for each number being dialled should be separated by the Delimiter. E.g. wwww2410<wwww1411
Each ‘w’ character waits 0.5 seconds instead of sending a digit.
Each ‘W’ character waits 0.5 seconds instead of sending a digit.
You can also add the tone duration in ms by appending @duration after string (default duration is 2000 ms).
Eg. 1w2w3@1000
SendOnPreanswer List of flag separated by Delimiter. If set to ‘true’, SendDigits is executed when called party is in early media instead of answer state. (default ‘false’)
TimeLimit This parameter will schedule the call for hangup at a specified time after the call is answered. It should be an integer >0 in seconds. TimeLimit for each number being dialled should be separated by the Delimiter. E.g. 5<10 The first call will hangup 5 seconds after it is answered while the second call will hangup 10 seconds after it is answered.
HangupOnRing This parameter will schedule the call for hangup at a specified time after the call starts ringing. It should be an integer >=0 in seconds. HangupOnRing for each number being dialled should be separated by the Delimiter. E.g. 5<10 The first call will hangup 5 seconds after it starts ringing while the second call will hangup 10 seconds after it starts ringing.

Response Parameters

When you initiate a RESTAPI, Plivo responds with the standard parameters as mentioned here. Along with that the following additional parameters are sent:

  • RequestUUID: A unique identifiers for the API request associated with the call initiated. E.g. "75b26856-8638-11e0-802c-6d99d509954e"

32 Responses to “Making an Outbound Group Call”

  1. I enjoy what you guys are usually up too.
    This sort of clever work and reporting! Keep up the fantastic works guys I’ve added you guys to my personal blogroll.

  2. I think everything typed was very logical. But, what about this?
    what if you were to create a awesome post title? I ain’t saying your information isn’t solid., but what if
    you added a title to maybe get a person’s attention?
    I mean Making an Outbound Group Call is kinda vanilla. You could look at
    Yahoo’s front page and see how they write news titles to
    grab viewers to click. You might try adding a video or a pic or two to get readers interested about what you’ve got to say.
    Just my opinion, it might bring your website a little bit more interesting.

  3. sex says:

    This design is incredible! You definitely know how to keep a reader amused.
    Between your wit and your videos, I was almost moved to start my own blog (well,
    almost…HaHa!) Great job. I really enjoyed what you had to say,
    and more than that, how you presented it. Too cool!

  4. Pretty nice post. I just stumbled upon your blog and wanted to mention that I have truly
    enjoyed browsing your weblog posts. In any case I will be subscribing for your rss
    feed and I hope you write again very soon!

  5. The Exchange is normally also home to all the powers that be sponsored
    policies of well. Modern an exception to this rule with some policies.

  6. Hi there, dobra kosmetyczka Radom just wanted to say, I loved this
    article dom opieki Warszawa. This was inspiring projektowanie wnętrz Radom.
    Keep submitting!

  7. Faishal says:

    hi. can anyone help me to make this website? i want this urgently. or give me a link where i can add my own gateway and to test my group calls

  8. 48442 says:

    Great delivery. Great 48442 justifications. Keep up the good
    spirit.

    This amazing post meble biurowe is worth everyone’s attention.
    When may I read more?

  9. Hello, simlock Samsung wanted to mention, I enjoyed this article p346206.
    This was funny simlock. Keep submitting!

  10. Great delivery. Solid transport medyczny justifications.
    Continue the amazing spirit.

    This amazing post transport medyczny is priceless.
    When can I garner more information?

  11. Hello, transport medyczny I would like to say, I enjoyed this blog post transport
    medyczny. It was inspiring link. Continue on writing!

  12. Way cool! Some extremely valid points! I appreciate you penning this
    article plus the rest of the website is extremely good.

  13. Great delivery. Sound simlock Samsung arguments. Keep up the great spirit.

    This kind of text p20313 is invaluable. When could I find out more?

  14. Incredible points. Outstanding depilacja laserowa Radom questions.

    Keep up the amazing effort.

    This kind of information depilacja laserowa Radom is worth everyone’s attention.
    How may I garner more information?

  15. here says:

    Touche. Outstanding here justifications. Maintain the good effort.

    This valuable post here is priceless. Where could
    I garner more information?

  16. wspaniała strona. Czytałam z zainteresowaniem.

  17. Я извиняюсь, но, по-моему, Вы ошибаетесь.
    Могу отстоять свою позицию. Пишите мне в PM, пообщаемся.

  18. You’re beautiful site owner. It filling rate is definitely extraordinary. It sort of can feel you are undertaking almost any exclusive trick. In addition, Your subject matter usually are work of genius. you have carried out an impressive hobby within this issue!

  19. Daniela says:

    I read a lot of interesting content here.
    Probably you spend a lot of time writing, i know how
    to save you a lot of work, there is an online tool that creates unique, google friendly articles in seconds,
    just type in google – laranitas free content source

  20. Si vous aimez cette triche laisser vos commentaires ci-dessous et vous pouvez être
    invité à tester hacks et des programmes spéciaux dans un avenir
    proche.

  21. Josh says:

    If ѕome onne neeԀs to bbe uldated ѡith mߋst recennt technologies after that he must
    be go to ѕee thiѕ web ρage ɑnd be սp to date all
    tɦe time.

  22. Thank you for sharing excellent informations. Your web site is very cool. I am impressed by the details that you have on this web site. It reveals how nicely you understand this subject. Bookmarked this web page, will come back for extra articles. You, my friend, ROCK! I found simply the info I already searched all over the place and just couldn’t come across. What a perfect web-site.

  23. Only wanna input on few general things, The website layout is perfect, the content material is really superb. “The stars are constantly shining, but often we do not see them until the dark hours.” by Earl Riney.

  24. Nilda says:

    Perhaps your situation involves a private residence. I’d recommend learning about it
    by clicking on this Synthia 6 review, there is a link at the end of the blog article.

    Most of the New Yorkers trust NY Emergency Locksmith Company that
    takes care of every lock & key problems occurring in day to day life.

  25. Bella says:

    Hi admin do you need unlimited articles for your site ?
    What if you could copy content from other sites, make it unique and publish on your site – i know the right tool for you,
    just search in google:
    loimqua’s article tool

  26. The Goji berry supplements have allowed me to get
    goji berries are sold in the 1730s. Well iit is easy!
    In learn this here now addition, the Goji Active. A whopping 148 milligrams of iron, Goji berry which they look plump and juicy.

    The goji berry extract protected brain neurons freom tthe learn this here now
    test. Okay, you know what tthe raved is about 4 ouncrs a
    daay or about eight prunes.

  27. hi!,I love your writing so a lot! share we communicate extra about your article
    on AOL? I need a specialist in this house
    to unravel my problem. May be that is you! Having a look ahead to
    look you.

  28. continue says:

    Don’t underestimate breathhing Then repedat the cycle of try
    this out start a diet or exercise and diet. Its all in top condition.

  29. Excellent issues altogether, you simply gained a emblem new reader. What could you suggest in regards to your put up that you simply made a few days in the past? Any sure?

  30. Thanks for sharing such a nice thought, article is pleasant, thats why i have read
    it entirely

  31. Thank you for the good writeup. It in reality was once a leisure account it. Glance advanced to far brought agreeable from you! However, how could we be in contact?

  32. It’s going to be finish of mine day, but before ending I am reading this impressive article to increase my know-how.

Leave a Reply