OneCallNow Web Service

OneCallNow

Click here for a complete list of operations.

Login

Login is used to authenticate the calling user. The return value is an OCNErrorCode. The 4th parameter returns the login token that must be passed into all subsequent web service calls.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /WebServiceSource/2.82/onecallnow.asmx HTTP/1.1
Host: api.onecallnow.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.onecallnow.com/WebService/Login"

<?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>
    <Login xmlns="https://www.onecallnow.com/WebService/">
      <Service>int</Service>
      <GroupKey>int</GroupKey>
      <Pin>string</Pin>
      <LoginToken>string</LoginToken>
    </Login>
  </soap:Body>
</soap:Envelope>

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>
    <LoginResponse xmlns="https://www.onecallnow.com/WebService/">
      <LoginResult>NoError or InternalSystemError or LoginFailedInvalidGroupOrPin or GroupNotFound or InvalidSubGroupInList or ThisMessengerCannotSendToAllMembers or ThisMessengerCannotSendToAllGroups or MessengerDoesNotHaveAccessToSubGroup or NoMembersInSubGroup or FailedToGetDeliveryCount or FailedToRetrieveCallCredits or NotEnoughCreditToSendMessage or FailedToAllocateMessageID or NotLoggedIn or InvalidTTSVoice or InvalidTTSSetting or InvalidStartHour or InvalidEndHour or NoTTSMessageIdentified or MessageStartDateInPast or FailedToInstallMessageFile or InvalidPhoneNumber or FailedToAddDeliveryRecord or InvalidMessageBuilderCode or InvalidCannedCallCode or FailedToSubmitCannedCall or FileUploadFailed or AutoCallFeatureNotEnabled or MessageBuilderFeatureNotEnabled or TextToSpeechFeatureNotEnabled or NoMessageBuilderComponents or GroupNotActive or EmailFeatureNotEnabled or FailedToSendEmail or EmailNotSentInappropriateWords or SubjectLineMissing or NoEmailAddressesInGroupOrSubGroups or SubjectLineTooLong or EmailMessageMissing or EmailMessageTooLong or ReplyToAddressMissing or FailedToLoadCallListFile or CallListFileNotSpecified or MessageBuilderHasInvalidComponents or InvalidDocEncodingFormat or InvalidWAVFileTransferred or ExcessiveUsage or IntroTooLong or TextMessageTooLong or MessageIntroMissing or TextMessageMissing or NoSMSAddressesInGroupOrSubGroups or InvalidMessageStartDate or SavedMessageNotForRosterDestinations or InvalidDestinationSource or InvalidSavedMessageCode or AccessDenied or ThePhoneMessageisTooLong or TextMessageFeatureNotEnabled or PhoneMessageNotDefined or HotTransferNotEnabled or InvalidHotTransferOptions or PollingNotEnabled or PrimaryNumberAndSequenceNotSupported. or QuotaNotEnabled or NoOriginationNumberEntered or AnswerflexNotEnabled or PinFeatureNotEnabled or PinNotSet or SequenceByPhoneNumberNotEnabled or PrimaryNumberFeatureNotEnabled or SequenceByMemberNotEnabled or AdvanceMessagingOptionsNotEnabled or FailedRosterUpdate or RosterUpdateHadInvalidDestinations or InvalidSearchParameter or InvalidAudioFileID or MessengerCannotViewOrUpdateRoster or MemberAccessCodeNotNumeric or FileDoesNotMatchMessageBuilderDefinition or InvalidOperation or InvalidAudioFileLanguage or InvalidSubGroup</LoginResult>
      <LoginToken>string</LoginToken>
    </LoginResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /WebServiceSource/2.82/onecallnow.asmx HTTP/1.1
Host: api.onecallnow.com
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>
    <Login xmlns="https://www.onecallnow.com/WebService/">
      <Service>int</Service>
      <GroupKey>int</GroupKey>
      <Pin>string</Pin>
      <LoginToken>string</LoginToken>
    </Login>
  </soap12:Body>
</soap12:Envelope>

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>
    <LoginResponse xmlns="https://www.onecallnow.com/WebService/">
      <LoginResult>NoError or InternalSystemError or LoginFailedInvalidGroupOrPin or GroupNotFound or InvalidSubGroupInList or ThisMessengerCannotSendToAllMembers or ThisMessengerCannotSendToAllGroups or MessengerDoesNotHaveAccessToSubGroup or NoMembersInSubGroup or FailedToGetDeliveryCount or FailedToRetrieveCallCredits or NotEnoughCreditToSendMessage or FailedToAllocateMessageID or NotLoggedIn or InvalidTTSVoice or InvalidTTSSetting or InvalidStartHour or InvalidEndHour or NoTTSMessageIdentified or MessageStartDateInPast or FailedToInstallMessageFile or InvalidPhoneNumber or FailedToAddDeliveryRecord or InvalidMessageBuilderCode or InvalidCannedCallCode or FailedToSubmitCannedCall or FileUploadFailed or AutoCallFeatureNotEnabled or MessageBuilderFeatureNotEnabled or TextToSpeechFeatureNotEnabled or NoMessageBuilderComponents or GroupNotActive or EmailFeatureNotEnabled or FailedToSendEmail or EmailNotSentInappropriateWords or SubjectLineMissing or NoEmailAddressesInGroupOrSubGroups or SubjectLineTooLong or EmailMessageMissing or EmailMessageTooLong or ReplyToAddressMissing or FailedToLoadCallListFile or CallListFileNotSpecified or MessageBuilderHasInvalidComponents or InvalidDocEncodingFormat or InvalidWAVFileTransferred or ExcessiveUsage or IntroTooLong or TextMessageTooLong or MessageIntroMissing or TextMessageMissing or NoSMSAddressesInGroupOrSubGroups or InvalidMessageStartDate or SavedMessageNotForRosterDestinations or InvalidDestinationSource or InvalidSavedMessageCode or AccessDenied or ThePhoneMessageisTooLong or TextMessageFeatureNotEnabled or PhoneMessageNotDefined or HotTransferNotEnabled or InvalidHotTransferOptions or PollingNotEnabled or PrimaryNumberAndSequenceNotSupported. or QuotaNotEnabled or NoOriginationNumberEntered or AnswerflexNotEnabled or PinFeatureNotEnabled or PinNotSet or SequenceByPhoneNumberNotEnabled or PrimaryNumberFeatureNotEnabled or SequenceByMemberNotEnabled or AdvanceMessagingOptionsNotEnabled or FailedRosterUpdate or RosterUpdateHadInvalidDestinations or InvalidSearchParameter or InvalidAudioFileID or MessengerCannotViewOrUpdateRoster or MemberAccessCodeNotNumeric or FileDoesNotMatchMessageBuilderDefinition or InvalidOperation or InvalidAudioFileLanguage or InvalidSubGroup</LoginResult>
      <LoginToken>string</LoginToken>
    </LoginResponse>
  </soap12:Body>
</soap12:Envelope>