Edit

API này dùng để update chiến dịch.

curl --location --request PUT 'https://{{base_url}}/v3/campaign/c2da23c0-9739-4287-828a-7b15cf0fb19e' \
--header 'Content-type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data '{
    "campaign_uuid": "c2da23c0-9739-4287-828a-7b15cf0fb19e",
    "campaign_name": "AutocallAudio",
    "type": "autocall",
    "description": "",
    "active": true,
    "concurrent_call": 5,
    "carrier_uuid": "a18b400f-d487-4e17-b5e7-eba5fe6fa54f",
    "template_uuid": "5f427552-857e-4939-8edf-cbd0f1ef6842",
    "recall_times": 3,
    "limit_recall_duration": 0,
    "schedule_recall": "minute",
    "schedule_recall_duration": 1,
    "answer_callback_url": "",
    "status": "stop",
    "created_at": "2023-03-06T16:27:17.784242+07:00",
    "updated_at": "2023-03-06T16:27:17.784242+07:00",
    "template_name": "",
    "carrier_name": "",
    "mode_call": "direct",
    "network": {
        "viettel": 0,
        "mobi": 0,
        "vina": 0,
        "tel": 0,
        "offnet": 0
    },
    "run_id": "",
    "type_autocall": "autocall_audio",
    "call_timeout": 60,
    "domain_name": "",
    "users": [],
    "groups": [],
    "statuses": [],
    "schedules": [
        {
            "monday_start_time": 28800000000000,
            "monday_end_time": 75600000000000,
            "tuesday_start_time": 28800000000000,
            "tuesday_end_time": 75600000000000,
            "wednesday_start_time": 28800000000000,
            "wednesday_end_time": 75600000000000,
            "thursday_start_time": 28800000000000,
            "thursday_end_time": 75600000000000,
            "friday_start_time": 28800000000000,
            "friday_end_time": 75600000000000,
            "saturday_start_time": 28800000000000,
            "saturday_end_time": 75600000000000,
            "sunday_start_time": 28800000000000,
            "sunday_end_time": 75600000000000
        }
    ],
    "priority_recall": "normal",
    "recall_status": [
        "busy",
        "failed",
        "no-answered",
        "not-available",
        "voicemail",
        "invalid-number",
        "phone-block",
        "congestion"
    ],
    "enable_encrypt": false,
    "callback_url": "",
    "orig_campaign_uuid": ""
}'

Response trả về:

{
	"campaign_uuid": "c2da23c0-9739-4287-828a-7b15cf0fb19e"
}

Error Response trả về:

{
	"error": "campaign_name is already taken"
}

HTTP Request

PUT https://{{base_url}}/v3/campaign/{{campaign_uuid}}

Body

Sample data:

{
	"campaign_uuid": "c2da23c0-9739-4287-828a-7b15cf0fb19e",
	"campaign_name": "AutocallAudio",
	"type": "autocall",
	"description": "",
	"active": true,
	"concurrent_call": 5,
	"carrier_uuid": "a18b400f-d487-4e17-b5e7-eba5fe6fa54f",
	"template_uuid": "5f427552-857e-4939-8edf-cbd0f1ef6842",
	"recall_times": 3,
	"limit_recall_duration": 0,
	"schedule_recall": "minute",
	"schedule_recall_duration": 1,
	"status": "stop",
	"created_at": "2023-03-06T16:27:17.784242+07:00",
	"updated_at": "2023-03-06T16:27:17.784242+07:00",
	"template_name": "",
	"carrier_name": "",
	"mode_call": "direct",
	"network": {
		"viettel": 0,
		"mobi": 0,
		"vina": 0,
		"tel": 0,
		"offnet": 0
	},
	"run_id": "",
	"type_autocall": "autocall_audio",
	"call_timeout": 60,
	"schedules": [
		{
			"monday_start_time": 28800000000000,
			"monday_end_time": 75600000000000,
			"tuesday_start_time": 28800000000000,
			"tuesday_end_time": 75600000000000,
			"wednesday_start_time": 28800000000000,
			"wednesday_end_time": 75600000000000,
			"thursday_start_time": 28800000000000,
			"thursday_end_time": 75600000000000,
			"friday_start_time": 28800000000000,
			"friday_end_time": 75600000000000,
			"saturday_start_time": 28800000000000,
			"saturday_end_time": 75600000000000,
			"sunday_start_time": 28800000000000,
			"sunday_end_time": 75600000000000
		}
	],
	"priority_recall": "normal",
	"recall_status": ["busy", "failed", "no-answered", "not-available", "voicemail", "invalid-number", "phone-block", "congestion"],
	"callback_url": ""
}

Parameter	Description	Required
campaign_name	Tên chiến dịch	x
concurrent_call	Số lượng cuộc gọi đồng thời
type	Loại chiến dich, bao gồm autodialer, autocall, inbound, manual	x
template_uuid	Kịch bản gọi autocall
description	Mô tả chiến dịch
type_autocall	Loại chiến dịch autocall, bao gồm autocall_voice_tts, autocall_audio va autocall_voice_otp
carrier_uuid	UUID của carrier hay đầu số thực hiện cuộc gọi
recall_times	Số lần gọi lại
limit_recall_duration	Thời gian giới hạn gọi lại, tính theo giây
schedule_recall	Lịch gọi lại
schedule_recall_duration	Thời gian lịch gọi lại, tính theo phút
status	Trạng thái của chiến dịch, bao gồm stop, start, pause
created_at	Thời gian tạo chiến dịch
updated_at	Thời gian cập nhật chiến dịch
template_name	Tên kịch bản gọi autocall
carrier_name	Tên carrier hay đầu số thực hiện cuộc gọi
mode_call	Chế độ gọi, bao gồm direct, serial, parralel
network	Gọi theo mạng di động, bao gồm viettel, mobi, vina, tel, offnet
run_id	ID của chiến dịch đang chạy
type_autocall	Loại chiến dịch autocall, bao gồm autocall_voice_tts, autocall_audio va autocall_voice_otp
call_timeout	Thời gian timeout cuộc gọi, tính theo giây
schedules	Lịch gọi mỗi ngày của campaign, tính theo đơn vị nanosecond giây
priority_recall	Độ ưu tiên gọi lại của campaign, bao gồm normal, recall
recall_status	Các trạng thái gọi lại của campaign
callback_url	URL callback khi có CDR cuộc gọi

HTTP Request​

Body​

HTTP Request

Body