Suggestions

close search

Project management

Create a project

URL: https://api.stringee.com/v1/project

HTTP method: POST

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see Account Authentication

POST data (body):

{
    "name": "PROJECT_NAME"
}

Field	Type	Require	Description
name	String	Yes	The project name
answer_url	String	No	The answer url project return a SCCO object to control the call
callback_url	String	No	The callback url project will received events when the state of the call changes

Response:

{
    "r": RESULT_CODE,
    "account_sid": "YOUR_ACCOUNT_SID",
    "message": "RESULT_MESSAGE",
    "data": YOUR_DATA_PROJECT,
}

Field	Type	Require	Description
r	Int	Yes	Result code
account_sid	String	Yes	Your account sid
message	String	Yes	Result message
data	Int	Yes	Your project data if create successfully

Sample request

POST /v1/project HTTP/1.1
Host: https://api.stringee.com
X-STRINGEE-AUTH: json_web_token
Accept: application/json

{
    "name": "Project 100"
}

Sample response

{
    "r": 0,
    "account_sid": "AC59e79ea09224c5656be437a0f3dafd2f",
    "message": "Load project success",
    "data": {
        "id": 347,
        "name": "Project 100",
        "answer_url": "",
        "callback_url": "",
        "api_key_sid": "SK9ntgoHY5m0y38x39kXPQ1xI6PX5nOrJE",
        "api_key": "QUoyb2cyUHA1c0U2NUtCV0o1VTVpaHczc0ZVWXI4Mw=="
    }
}

Project list

URL: https://api.stringee.com/v1/project

HTTP method: GET

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see Account Authentication

GET parameters:

Field	Type	Require	Description
page	Int	NO	Page
name	String	NO	The name project

Response:

{
    "r": RESULT_CODE,
    "account_sid": "YOUR_ACCOUNT_SID",
    "message": "RESULT_MESSAGE",
    "data": {YOUR_DATA_PROJECT}
}

Field	Type	Require	Description
r	Int	Yes	Result code
account_sid	String	Yes	Your account sid
message	String	Yes	Result message
data	JSON	Yes	Your data project

Sample request

GET /v1/project HTTP/1.1
Host: https://api.stringee.com
X-STRINGEE-AUTH: json_web_token
Accept: application/json

Sample response

{
    "r": 0,
    "message": "Load project success",
    "account_sid": "AC59e79ea09224c5656be437a0f3dafd2f",
    "data": {
        "project": [
            {
                "id": 332,
                "account_sid": "AC59e79ea09224c5656be437a0f3dafd2f",
                "name": "Project 1",
                "callback_url": "",
                "answer_url": "",
                "api_key_sid": "SKur41EjotWrrBZzTPSEi57ZjQvsRHJns",
                "api_key": "TDMyQmFzNmtoTkF3OFpaaVhSZ2RxS1JwTXZNckt0dg==",
                "created": 1536898212
            },
        ],
        "totalPages": 1,
        "totalCount": 1,
        "activePage": 1
    }
}

Delete a project

URL: https://api.stringee.com/v1/project/{PROJECT_ID}

HTTP method: DELETE

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see Account Authentication

URI Parameters:

Field	Type	Require	Description
{PROJECT_ID}	String	Yes	The project ID

Response:

{
    "r": RESULT_CODE,
    "account_sid": "YOUR_ACCOUNT_SID",
    "message": "RESULT_MESSAGE"
}

Field	Type	Require	Description
r	Int	Yes	Result code
account_sid	String	Yes	Your account sid
message	String	No	Result message

Sample request

DELETE /v1/project/341 HTTP/1.1
Host: https://api.stringee.com
X-STRINGEE-AUTH: json_web_token
Accept: application/json

Sample response

{
    "r": 0,
    "account_sid": "AC59e79ea09224c5656be437a0f3dafd2f",
    "message": "Delete project success"
}

Update a project

URL: https://api.stringee.com/v1/project/{PROJECT_ID}

HTTP method: PUT

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see Account Authentication

PUT data (body):

{
    "name": "NAME_PROJECT"
}

Field	Type	Require	Description
name	String	Yes	The project name
answer_url	String	No	The answer url project
callback_url	String	No	The callback url project

URI Parameters:

Field	Type	Require	Description
{PROJECT_ID}	String	Yes	The project ID

Response:

{
    "r": RESULT_CODE,
    "account_sid": "YOUR ACCOUNT SID",
    "message": "RESULT_MESSAGE"
}

Field	Type	Require	Description
r	Int	Yes	Result code
account_sid	String	Yes	Your account sid
message	String	Yes	Result message

Sample request

PUT /v1/project/340 HTTP/1.1
Host: https://api.stringee.com
X-STRINGEE-AUTH: json_web_token
Accept: application/json

{
    "name": "New Name Project"
}

Sample response

{
    "r": 0,
    "message": "Update project success",
    "account_sid": "AC59e79ea09224c5656be437a0f3dafd2f"
}