Voice Broadcast API

Voice API
Quick Start Guides
Methods
Types
FAQ

CancelConference

Use this method to cancel a conference.

Syntax

CancelConference(ConferenceKey)

Request Parameters

Parameter NameDescriptionData TypeRequiredSample Value
ConferenceKeyThe key of the conference you want to cancel.StringTrueb825700e-5180-4e77-8599-2e2eb6c4c1ba

Response

Returns: void

Code Samples

You can use any programming language you want with our API, as long as it can make a REST or SOAP call. Here are examples for some of the most common platforms.

C#

/* https://ws.esendex.us/notifyws/phonenotify.asmx?wsdl was added as a Service Reference and given the name WSDL */

using WSDL;

var client = new PhoneNotifySoapClient(PhoneNotifySoapClient.EndpointConfiguration.PhoneNotifySoap);
var conferenceKey = "b825700e-5180-4e77-8599-2e2eb6c4c1ba";
await client.CancelConferenceAsync(conferenceKey);

Console.WriteLine("Conference cancelled");

Python

import zeep

client = zeep.Client(wsdl="https://ws.esendex.us/notifyws/phonenotify.asmx?wsdl")
conference_key = "b825700e-5180-4e77-8599-2e2eb6c4c1ba"

result = client.service.CancelConference(conference_key)

print(result)

GET Request

GET /NotifyWS/PhoneNotify.asmx/CancelConference?ConferenceKey=string HTTP/1.1
Host: ws.esendex.us

POST Request

POST /NotifyWS/PhoneNotify.asmx/CancelConference HTTP/1.1
Host: ws.esendex.us
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ConferenceKey=string

SOAP 1.1 Request

POST /NotifyWS/PhoneNotify.asmx HTTP/1.1
Host: ws.esendex.us
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://ws.esendex.us/NotifyWS/CancelConference"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CancelConference xmlns="https://ws.esendex.us/NotifyWS/">
      <ConferenceKey>string</ConferenceKey>
    </CancelConference>
  </soap:Body>
</soap:Envelope>

SOAP 1.1 Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CancelConferenceResponse xmlns="https://ws.esendex.us/NotifyWS/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2 Request

POST /NotifyWS/PhoneNotify.asmx HTTP/1.1
Host: ws.esendex.us
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CancelConference xmlns="https://ws.esendex.us/NotifyWS/">
      <ConferenceKey>string</ConferenceKey>
    </CancelConference>
  </soap12:Body>
</soap12:Envelope>

SOAP 1.2 Response

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CancelConferenceResponse xmlns="https://ws.esendex.us/NotifyWS/" />
  </soap12:Body>
</soap12:Envelope>

XML Response

HTTP/1.1 200 OK

Let’s start sending, together.