ExternalAccountEndpoint

The following resources are applicable:

/external/account/connect

Mount Point: /rest/external/account/connect

POST

Connects an external account (google, facebook, ...) to an mysms user.

Error Codes

2A required parameter is invalid
97The access to the api was denied
98You made too much requests in a short time
99The service is currently not available
600The api key is invalid
1100The external account is not valid (oauth token wrong)
1102The external account is unavailable

Request Body

element: externalAccountConnectRequest
media types: */*
application/xml
application/json

(no documentation provided)

Response Body

element: externalAccountConnectResponse
media types: */*
application/xml
application/json

(no documentation provided)

/external/account/create

Mount Point: /rest/external/account/create

POST

Creates an account and connects the external account (google, facebook, ...) to it.

Error Codes

2A required parameter is invalid
97The access to the api was denied
98You made too much requests in a short time
99The service is currently not available
600The api key is invalid
1100The external account is not valid (oauth token wrong)
1102The external account is unavailable
1103The external account is already connected to an user.

Request Body

element: externalAccountCreateRequest
media types: */*
application/xml
application/json

(no documentation provided)

Response Body

element: externalAccountCreateResponse
media types: */*
application/xml
application/json

(no documentation provided)

/external/account/delete

Mount Point: /rest/external/account/delete

POST

Deletes an external account (google, facebook, ...) from an mysms user.

Error Codes

2A required parameter is invalid
97The access to the api was denied
98You made too much requests in a short time
99The service is currently not available
600The api key is invalid
1100The external account is not valid (oauth token wrong)
1102The external account is unavailable

Request Body

element: externalAccountDeleteRequest
media types: */*
application/xml
application/json

(no documentation provided)

Response Body

element: externalAccountDeleteResponse
media types: */*
application/xml
application/json

(no documentation provided)

/external/account/disconnect

Mount Point: /rest/external/account/disconnect

POST

Disconnects an external account (google, facebook, ...) from an mysms user.

Error Codes

2A required parameter is invalid
97The access to the api was denied
98You made too much requests in a short time
99The service is currently not available
600The api key is invalid
1100The external account is not valid (oauth token wrong)
1102The external account is unavailable

Request Body

element: externalAccountDisconnectRequest
media types: */*
application/xml
application/json

(no documentation provided)

Response Body

element: externalAccountDisconnectResponse
media types: */*
application/xml
application/json

(no documentation provided)

/external/account/get/token

Mount Point: /rest/external/account/get/token

POST

Get a new access token from an refresh token.

Error Codes

2A required parameter is invalid
97The access to the api was denied
98You made too much requests in a short time
99The service is currently not available
600The api key is invalid
1101The external account is not connected to an user.
1102The external account is unavailable

Request Body

element: externalAccountGetTokenRequest
media types: */*
application/xml
application/json

(no documentation provided)

Response Body

element: externalAccountGetTokenResponse
media types: */*
application/xml
application/json

(no documentation provided)

/external/account/initiate

Mount Point: /rest/external/account/initiate

POST

Initiates an external OAuth 1.0 flow (google, facebook, ...)

Error Codes

2A required parameter is invalid
97The access to the api was denied
98You made too much requests in a short time
99The service is currently not available
600The api key is invalid
1102The external account is unavailable

Request Body

element: externalAccountInitiateRequest
media types: */*
application/xml
application/json

(no documentation provided)

Response Body

element: externalAccountInitiateResponse
media types: */*
application/xml
application/json

(no documentation provided)

/external/account/login

Mount Point: /rest/external/account/login

POST

Authenticates an user by a connected service and returns the auth token which have to be used on any following api call to a method which needs authentication.

Error Codes

2A required parameter is invalid
97The access to the api was denied
98You made too much requests in a short time
99The service is currently not available
109The login is blocked for a specific time, because some wrong logins were made
600The api key is invalid
1100The external account is not valid (oauth token wrong)
1101The external account is not connected to an user
1102The external account is unavailable

Request Body

element: externalAccountLoginRequest
media types: */*
application/xml
application/json

(no documentation provided)

Response Body

element: externalAccountLoginResponse
media types: */*
application/xml
application/json

(no documentation provided)

/external/account/validate

Mount Point: /rest/external/account/validate

POST

Validates an OAuth token after the authorization page was passed. Returns an validated OAuth token that can be used to login, connect & disconnect

Error Codes

2A required parameter is invalid
97The access to the api was denied
98You made too much requests in a short time
99The service is currently not available
600The api key is invalid
1100The external account is not valid (oauth token wrong)
1102The external account is unavailable

Request Body

element: externalAccountValidateRequest
media types: */*
application/xml
application/json

(no documentation provided)

Response Body

element: externalAccountValidateResponse
media types: */*
application/xml
application/json

(no documentation provided)