HTTP(S) Service - Methods - CancelParticipant

CancelParticipant

This method is used to cancel an individual TextSurvey session that is currently in progress.

When a number is passed to this method, if a user with that number is currently participating in your Survey, their session will be cancelled.

» returnCSVString» Boolean
» externalLogin» String
» password» String
» number» String
» surveyID » Integer

On successful completion, this method will return transaction code 1.

If the survey cannot be found, this method will return transaction code 386 (Survey not found).

ClientMessageReference the value of the given clientMessageReference
Originator the sender of the message
Destination the number to which the reply was sent
Date the date that the message was received
Time the time that the message was received
Body the content of the message

Return Data

XML:


        <CancelParticipantResponse> 
            <Transaction> 
                <IP>123.123.123.123</IP> 
                <Code>1</Code> 
                <Description>Transaction  OK</Description> 
            </Transaction> 
        </CancelParticipantResponse>
        

CSV:

#1# "1"

Footer Bottom