API

  • Instructions - Check out FAQ page to learn more about API features.
    • Input
      • All API requests should be directed to
        http://api.udefn.com/apigateway.ashx
      • All API requests can either be GET or POST
      • Give API Sampler a try and see how simple our API is
    • Authorization
      • Before using API, please sign in to your account and click "Settings" link. Make sure you have generated an API key, if not, click Enable API Key to generate one. You have to pass this API key in every API call. We recommend you periodically change your API key by clicking on Change API Key under Settings.
      • All API requests with the exception of few methods like SignIn require authorization
      • Authorization can be provided as
        username=usernameValue&apiKey=apiKeyValue
        for each request or you can SignIn with the first call, caching the returned sessionID and passing
        sessionID=sessionIDValue
        in the subsequent calls. Multiple API requests can be sent using the same sessionID. When done, you can optionally call SignOut method to end the session (to prevent malicious access using the same sessionID)
      • In the samples below, white space characters have been added to improve readability. These should be removed prior to submitting
    • Output
      • Two output formats are supported. JSON (default) and XML
      • Output format can be specified in the request uri by appending
        outputType=Json
        or
        outputType=Xml
      • All output contain two mandatory elements. Error and Result. Error element contains information regarding any error encountered processing the API request, including parameter validations. Result element is populated depending on the return type of the target method.
  • Methods
    • Api
      • GetIncomingMessages  ( int count )
        type=Api& method=GetIncomingMessages&count=countValue
      • GetIncomingMessagesForBot  ( string botID , int count )
        type=Api& method=GetIncomingMessagesForBot&botID=botIDValue& count=countValue
      • SendOutgoingMessage  ( string moOutgoingID , string language , string body , bool responseExpected )
        type=Api& method=SendOutgoingMessage&moOutgoingID=moOutgoingIDValue& language=languageValue& body=bodyValue& responseExpected=responseExpectedValue
  • Types
    • bool 
    • Dictionary`2[]  
    • int 
    • MOOutgoingToBotBuilder 
      • MO_MOOutgoingID : string
      • MO_TransactionID : string
      • MO_BotID : string
      • MO_ProfileID : int
      • MO_Carrier : string
      • MO_Body : string
      • MO_Language : string
      • GN_SessionID : string
      • MO_GeneratedAtUtc : string
      • MO_ProcessedAtUtc : string
      • MO_ResponseBeforeUtc : string
      • MT_MaxLength : int
      • ProfileValues : Dictionary`2[]
    • MOOutgoingToBotBuilder[]  
      • MOOutgoingToBotBuilder[] : Array
    • string 
    • void 
Standard Messaging Rates Apply. Other charges may apply. Visit your carrier for more information. To unsubscribe, text stop to 51406. Text help to 51406 to learn more about udefn.
 
refresh_
Loading...
An error occurred while processing your request. Please try again. Sorry for the inconvenience.