Table of Contents
createAccountSession
Synopsis:
This API function creates a session for an account so that widgets can be launched and linked to it such as the SWF MMS Composer Object or the MMS Preview SWF Objects. Note that an account session can only be used for web-viewable resources for particular accounts with this API enabled.
Request: XML
<REQUEST>
<ACTION>createAccountSession</ACTION>
<API_KEY>apiKey</API_KEY>
</REQUEST>Request Parameters:
| Term | Mandatory/Optional | Description |
|---|---|---|
| ACTION | Mandatory | This is the name of the function you want to execute with the API. |
| API_KEY | Mandatory | Random key that is assigned to an account that can be used for authorization instead of USER/PASS. You can find and regenerate this key on the ‘API Settings’ page. |
Response Parameters:
| Param Name | Presence | Description |
| STATUS | Always | “Success” or “Failure”. |
| SESSIONID | Success response only | Unique ID of a session for the account so that widgets can be launched and linked to it. |
| ERRORCODE | Error response only | Error code associated with the error. |
| ERRORINFO | Error response only | Error message explaining the error code. |
Related Error Codes:
N/ARequest Example: XML
<REQUEST>
<ACTION>createAccountSession</ACTION>
<API_KEY>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</API_KEY>
</REQUEST>Response Example: Success
<RESPONSE>
<STATUS>Success</STATUS>
<SESSIONID>5147ca89c151574ce85225f59a115ec459b3c68a</SESSIONID>
</RESPONSE>Response Example: Failure
<RESPONSE>
<STATUS>Failure</STATUS>
<ERRORCODE>E107</ERRORCODE>
<ERRORINFO>This account has no rights to use this action.</ERRORINFO>
</RESPONSE>General Error Codes:
| Code | Description |
|---|---|
| E100 | Invalid request. Make a valid request via GET/POST/XML with all the required variables. |
| E104 | User Authentication Failed. |
| E105 | This account has no API rights. |
| E106 | You can call API every X seconds. |
| E107 | This account has no rights to use this action. |
| E108 | XML Parse error: $error. |
| E109 | API not activated. |
| E112 | IP was not whitelisted. API call rejected. |
| E113 | Set throughput exceeded for this API action. API call rejected. |
| E114 | Phone number is blacklisted. API call rejected. |
| E120 | Account has reached the API request limit. |
| E503 | Internal error. |